firebase / firebase/firebase-js-sdk
Confusion around generated docs file ai.aimodel.md and where edits should be made
- Dominant language
- TypeScript
- Stars
- 5.1k
- Forks
- 1k
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 37
Description
Hi,
While exploring the documentation inside `docs-devsite`, I came across `ai.aimodel.md`.
The file contains a note saying it is auto-generated and should not be edited directly.
However, as a new contributor, it was unclear:
• where the actual source of this documentation lives
• how contributors are expected to propose documentation improvements
• whether edits should be made in code comments, another repository location, or a generation config
It might help new contributors if the file (or contributor docs) included a short pointer explaining:
• where the source of truth is
• how documentation updates should be contributed
Happy to help improve contributor guidance if needed.
Thanks!
Contributor guide
Assessment
This issue has not been assessed yet.