Skip to content
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

Merged
merged 5 commits into from
Mar 5, 2024
Merged

RFC: Dev Docs #30274

merged 5 commits into from
Mar 5, 2024

Conversation

mltejera
Copy link
Contributor

@mltejera mltejera commented Jan 10, 2024

A proposal to update our dev docs.

Related PR scaffolding out new docs: #30483
Related Epic: #30642

@mltejera mltejera added the Type: RFC Request for Feedback label Jan 10, 2024
@fabricteam
Copy link
Collaborator

fabricteam commented Jan 10, 2024

📊 Bundle size report

🤖 This report was generated against 829593442496ca4481a9dacd5f1af4dda83bfec7

Copy link

codesandbox-ci bot commented Jan 10, 2024

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.

Copy link

size-auditor bot commented Jan 10, 2024

Asset size changes

Size Auditor did not detect a change in bundle size for any component!

Baseline commit: a95d5034819f1ca06dfb8a112cff878abe57e478 (build)

@mltejera mltejera marked this pull request as ready for review January 17, 2024 17:26
@mltejera mltejera requested a review from a team as a code owner January 17, 2024 17:26
@Hotell Hotell self-requested a review January 23, 2024 17:07
Copy link
Contributor

@Hotell Hotell left a 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:

image

Important think to note is that not all the docs can be public, how would you propose handling those ?

@Hotell Hotell mentioned this pull request Feb 21, 2024
@mltejera mltejera requested review from a team as code owners March 1, 2024 23:24
mltejera and others added 5 commits March 5, 2024 13:37
Co-authored-by: Makoto Morimoto <humbertomakotomorimoto@gmail.com>
Co-authored-by: Makoto Morimoto <humbertomakotomorimoto@gmail.com>
@mltejera mltejera requested a review from a team as a code owner March 5, 2024 21:39
@mltejera
Copy link
Contributor Author

mltejera commented Mar 5, 2024

Thanks for participating in this RFC folks - we're going to merge this and migrate things over.

@mltejera mltejera merged commit aa3ad83 into master Mar 5, 2024
19 of 20 checks passed
@mltejera mltejera deleted the user/matejera/dev-docs-rfc branch March 8, 2024 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: RFC Request for Feedback
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants