docs: update stale contributor setup and architecture in docs/README.md#650
Merged
Merged
Conversation
shogun444
force-pushed
the
docs-update-readme-636
branch
3 times, most recently
from
f615dd9 to
4fd1135
Compare
vishxrad
requested changes
Jun 15, 2026
shogun444
force-pushed
the
docs-update-readme-636
branch
from
2ad9a98 to
fec3517
Compare
Contributor
Author
|
Hi @vishxrad, I updated the pr could you please re-review. |
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
This updates
docs/README.mdto match the current repository structure and contributor workflow.The existing README referenced paths and packages that no longer exist, including
docs-v3,js/packages, and@openuidev/react-core. It also described an outdated project structure and setup process that does not reflect the current workspace.Changes
Rewrote the README to document the current
docs/workspace, updated the setup instructions to use the current pnpm workflow, refreshed the architecture and project structure sections, updated navigation and documentation organization details, and removed references to deprecated paths, packages, and symlinks.Test Plan
Validated the updated instructions by running
pnpm install,pnpm --filter @openuidev/docs dev, andpnpm --filter @openuidev/docs build. Also verified the documented paths, package references, and navigation structure against the current codebase.Checklist
closes #636