firebase-js-sdk icon indicating copy to clipboard operation
firebase-js-sdk copied to clipboard

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

Open brantgurga opened this issue 3 years ago • 2 comments

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.

brantgurga avatar Jun 28 '22 03:06 brantgurga

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

google-oss-bot avatar Jun 28 '22 03:06 google-oss-bot

The move/removal of index.d.ts seemed to come in https://github.com/firebase/firebase-js-sdk/commit/cdada6c68f9740d13dd6674bcb658e28e68253b6 for context

brantgurga avatar Jun 28 '22 04:06 brantgurga

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.

hsubox76 avatar Jun 16 '23 18:06 hsubox76