Update Documentation
Handle the operational workflow around docs.tenzir.com changes.
Workflow
- Ensure
.docs/exists and is up to date by cloningtenzir/docsor fetching fromorigin. - Create or check out a topic branch in
.docs/that matches the parent repo branch name. - Author the content update in
.docs/using the docs repository's own documentation guidance and conventions. - Run relevant documentation checks if the docs repository provides them.
- File a
tenzir/docspull request from.docs/. - Cross-link the pull requests (see also the
create-pull-requestsskill for the code-side PR workflow):- In the docs PR, add a
Functional PRssection linking the main PR. - In the main PR, add a
Documentation PRsection linking the docs PR.
- In the docs PR, add a
- Summarize what changed and note any follow-up work.
Branching
Keep the .docs/ branch name aligned with the code branch whenever possible.
If the code change spans multiple repositories, use the code branch as the
source of truth for naming and cross-links.
Cross-Checks
Before opening the docs PR:
- Confirm the changed pages still fit their Diataxis section.
- Check nearby pages and "See also" links for follow-on edits.
- Ensure code samples, paths, and UI labels match the current product behavior.