Skip to content

chore: update readme#57

Merged
maxy-shpfy merged 1 commit into
mainfrom
07-01-chore_update_readme
Jul 2, 2026
Merged

chore: update readme#57
maxy-shpfy merged 1 commit into
mainfrom
07-01-chore_update_readme

Conversation

@maxy-shpfy

@maxy-shpfy maxy-shpfy commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

TL;DR

Restructured the README to lead with a getting started guide and added UI/architecture screenshots.

What changed?

  • Moved the Getting started section (prerequisites, install/run instructions, seeding) to the top of the README, directly after the project introduction, so new users see it immediately
  • Renamed the former "Getting started" section to Operation manual to better reflect its content
  • Added a Terminology heading to the existing glossary items
  • Removed inline PI_PROXY_URL/PI_PROXY_API_KEY values from the example pnpm dev command, directing users to .env instead
  • Embedded two screenshots: shell-ui-1.png after the intro paragraph and slide-architecture-1.png after the project structure tree
  • Added three new image assets under docs/assets/: shell-ui-1.png, slide-architecture-1.png, and shell-collage-1.png

How to test?

Review the rendered README on the repository's main page and confirm:

  • The getting started steps appear near the top
  • Both images render correctly at 500px width
  • The operation manual/configuration content remains intact below the architecture section

Why make this change?

The previous README buried the getting started instructions after a long architectural overview, making onboarding harder than necessary. Promoting setup steps to the top and adding visual context (UI screenshot and architecture diagram) gives new contributors and users a faster path to running the project.

Copy link
Copy Markdown
Collaborator Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@maxy-shpfy maxy-shpfy force-pushed the 07-01-chore_update_readme branch from e246d50 to 1d5ae99 Compare July 2, 2026 00:18
@maxy-shpfy maxy-shpfy marked this pull request as ready for review July 2, 2026 00:18
@maxy-shpfy maxy-shpfy requested a review from a team July 2, 2026 00:18
@maxy-shpfy maxy-shpfy merged commit 1d5f948 into main Jul 2, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant