-
Notifications
You must be signed in to change notification settings - Fork 2.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
RFC: Dev Docs #30274
RFC: Dev Docs #30274
Conversation
📊 Bundle size report🤖 This report was generated against 829593442496ca4481a9dacd5f1af4dda83bfec7 |
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
Asset size changesSize Auditor did not detect a change in bundle size for any component! Baseline commit: a95d5034819f1ca06dfb8a112cff878abe57e478 (build) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tweaking the whole docs experience is a long time coming, unfortunately it was not on anyones priority list, so its great that someone can have time to improve it. thank you!
- +1 on stop using github wiki as it has its downsides
- I'd recommend to follow standard OSS practices in terms of having Contributing.md and Readme.md as a main crossroad documents ( which Github will suggest you while creating issues/PRs ) which would then link to particular scoped docs (v0,v8,v9,wc).
- naming is hard, but I dont think this is the most human readable entry
__docs__/
GitHub integration:
Important think to note is that not all the docs can be public, how would you propose handling those ?
Co-authored-by: Makoto Morimoto <humbertomakotomorimoto@gmail.com>
Co-authored-by: Makoto Morimoto <humbertomakotomorimoto@gmail.com>
8b22b0b
to
e0cab2a
Compare
Thanks for participating in this RFC folks - we're going to merge this and migrate things over. |
A proposal to update our dev docs.
Related PR scaffolding out new docs: #30483
Related Epic: #30642