docs(WARP): add crate overview section#11445
Conversation
Add a Crate Overview section to WARP.md listing key crates and their purposes: ai, channel_versions, command, editor, graphql, http_client, http_server, ipc, warpui, warpui_core, warp_core, app, and integration.
|
Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @okwn on file. In order for us to review and merge your code, each contributor must visit https://cla.warp.dev to read and agree to our CLA. Once you have done so, please comment |
|
This PR is not linked to an issue that is marked with Issue-state enforcement details:
To continue, link this PR to a same-repo issue such as Powered by Oz |
github-actions
Bot
added
the
external-contributor
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
There was a problem hiding this comment.
This PR is not linked to an issue that is marked with ready-to-implement.
Issue-state enforcement details:
-
Associated same-repo issues checked: none
-
Required readiness label:
ready-to-implement
To continue, link this PR to a same-repo issue such as Closes #123 in the PR description, and make sure that issue has ready-to-implement.
Powered by Oz
|
@cla-bot check |
|
The cla-bot has been summoned, and re-checked this pull request! |
|
@okwn The linked issue does not appear related to the pr itself |
2 participants
Summary
Add a Crate Overview section to WARP.md listing key crates and their purposes:
For each crate: where it is located, what it does, and why it matters for contributors.
Why this matters
New contributors don't know where to start when looking at the codebase. A clear map of the crate architecture helps them find the right file faster.
Changes
Validation
Read WARP.md Crate Overview section and verify all listed crates exist.
Risk/Compatibility
Documentation only. No code or API changes.
Closes #11349 (File tree view's recursive watcher re-walks large subtrees)