docs: improve documentation discoverability#335
Merged
Conversation
dcalhoun
force-pushed
the
docs/improve-documentation-discoverability
branch
from
0f7b082 to
9f361c9
Compare
kean
approved these changes
Feb 25, 2026
Contributor
kean
left a comment
kean
left a comment
There was a problem hiding this comment.
Thank you!
I hope it doesn't negatively affect the agents, but I can't see the reasons why it should.
| - Native-to-web bridge for communication between platforms | ||
|
|
||
| The primary branch is `trunk` (not `main`). | ||
| For deeper architectural context on specific subsystems, see the docs under `docs/code/` — including `architecture.md`, `plugins.md`, `preloading.md`, and others. |
Contributor
There was a problem hiding this comment.
(nit) Shouldn't it use the @ symbol? I'm not completely sure if it actually affects anything now, but I'm just wondering.
Member
Author
There was a problem hiding this comment.
I had the same thought. I'm unsure what is most appropriate for this particular context of "let's reduce the generic prompt given to the agent." Does using @ inject all of the contents from the file path? Does avoiding @ prevent that? 🤷🏻
Surface the Getting Started guide and Contributing Guide as a clear entry point for new contributors landing on the project README.
Remove information that is duplicated elsewhere in the project: - Detailed command listings (available via `make help`) - Architecture details (documented in `docs/code/architecture.md`) - Logging and lint guidelines (enforced by ESLint config) Consolidate remaining guidance and add Conventional Commits note to the pull request guidelines section.
dcalhoun
force-pushed
the
docs/improve-documentation-discoverability
branch
from
9f361c9 to
513539c
Compare
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
2 participants
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.
What?
Improve discoverability of contributing and development setup documentation.
Why?
Addresses review feedback from #328 suggesting that developer-facing documentation be more discoverable from the project README, and that
AGENTS.mdbe trimmed to reduce redundancy with existing docs.How?
make help, architecture details fromdocs/code/, logging/lint guidelines enforced by ESLint). Consolidate remaining agent-specific guidance.Testing Instructions
docs/code/getting-started.mdandCONTRIBUTING.mdAGENTS.mdstill contains essential agent guidance (make commands, code quality, pitfalls)make helpand confirm the removed command listings are available thereAccessibility Testing Instructions
N/A — documentation-only changes.