-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
category: style guideRelates to the code style guideRelates to the code style guidetype: documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Could be useful to:
- New devs/contributors
- Those using agentic or other AI tools to help write documentation
to have a clear guide for how documentation should be approached as part of the integrated process of contribution.
Documenting the simple stuff like:
- What docstring format to use/when to apply different levels of detail
- Whose responsibility/when to update formal docs - e.g. does it have to be packaged alongside feature PRs? Or only at version updates?
- Structure for documenting bits with ISP version differences
- Template(s) where they make sense (e.g. table docs)
Just to have that written down somewhere for reference could be useful.
Metadata
Metadata
Assignees
Labels
category: style guideRelates to the code style guideRelates to the code style guidetype: documentationImprovements or additions to documentationImprovements or additions to documentation