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

Contributing.MD was not updated for repository rearrangement in relation to the index.d.ts link #6395

Open
brantgurga opened this issue Jun 28, 2022 · 3 comments
Assignees

Comments

@brantgurga
Copy link
Contributor

The Contributing.md file was not updated and refers to a single index.d.ts file that contains the documentation. Such files got moved around at some point so that link is no longer correct and overall concept may no longer be right.

@google-oss-bot
Copy link
Contributor

I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.

@brantgurga
Copy link
Contributor Author

The move/removal of index.d.ts seemed to come in cdada6c for context

@hsubox76
Copy link
Contributor

We need to update the Updating Documentation section and keep the current section as "how to update compat docs" and move it lower, and add a new, top section on "how to update modular docs". The "how to find what text to update" part is not going to be simple but we should explain the general idea of it and I guess encourage people to search and do their best, and then the generation is just yarn docgen devsite.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants