Repository navigation
docs: restructure README so users can judge fit first - #460
Merged
Merged
Conversation
…tail Move architecture, prompt flow and code map to docs/architecture.md and dev/packaging commands to CONTRIBUTING.md; correct claims that extensions can already contribute Dock panels. Repoint AGENTS.md and verify-pace.
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrite of the README, following better-readme: user-facing content goes first, and contributor material moves out (moved, not deleted).
docs/architecture.md(Chinese, matching the rest ofdocs/): full design principles, mermaid pipeline, layer bullets, prompt flow, the "Where things live" table, extension points, repo layout, stack, storage-compat rule.CONTRIBUTING.md:test:e2e/test:release, packaging commands, theValidate macOS ARM64note,/designand UI Intent Picker, and the documentation map.AGENTS.mdnow namesdocs/architecture.mdas the code map andCONTRIBUTING.mdfor the full command list;.cursor/skills/verify-pacepoints to CONTRIBUTING "Setup".surface-registry.tsallows only the 4 built-in surface ids and has noproviderfield, and the extension UI request appears only inpi-sdk-spike.ts, not the gateway. The README no longer says extensions can contribute Dock panels today.Test plan
~/.pi/agent, macOS 12 minimum in electron-builder.yml)