annotate

To add team annotations to engineering documentation, you provide the entry-id and your annotation note. The tool records concise annotations directly on documentation entries to provide context and tracking for decisions, ensuring issues, fixes, and conventions persist with the content.

You track issues and fixes on knowledge base entries by attaching concise notes to the documentation. The tool auto-detects the annotation kind, such as issue, fix, or practice, based on the note content and classifies it accordingly for team-wide visibility.

Sharing decisions and conventions on a team playbook is done by using the chub_annotate command in team scope. This creates shared annotations on the playbook entries, capturing organizational learnings and making them accessible across the team.

Yes, you can attach notes to documentation entries without manual classification. The tool auto-detects the annotation kind, categorizing it as an issue, fix, or practice automatically based on the content of the note you provide.

Yes, recording team annotations on docs relies on the chub_annotate command with the scope set to team. You provide the entry-id and your annotation note as inputs to satisfy the frontmatter requirements and create the annotation.

You should use documentation annotations when traceability of issues, fixes, and conventions matters. It is applied to engineering docs, playbooks, and knowledge bases where recording concise context directly on entries ensures decisions and learnings persist.