Skip to content
Componecat Docs

Documentation and activity

Knowledge about a component tends to scatter across wikis, READMEs, and chat. Componecat pulls it onto the entity itself, where it’s searchable and where an AI agent can retrieve it. Any entity whose kind has documentation enabled can carry Markdown sections, external links, and a running activity log.

Documentation sections

Section titled “Documentation sections”

A section is a named piece of Markdown — Overview, Architecture, Runbook, API Reference, ADRs, Changelog, or anything you name yourself. Sections are ordered, rendered with syntax highlighting and Mermaid diagrams, and individually full-text searchable, so they show up in catalog search alongside entities.

Section titled “Documentation links”

Not everything should be copied into Componecat. Attach links to external docs — Confluence, Notion, Google Docs, dashboards — with a type label, so the entity stays the single place you start from even when the content lives elsewhere.

Git-sourced documentation

Section titled “Git-sourced documentation”

You can keep documentation next to the code and let Componecat import it. Point a section at a repository’s /docs folder (or a specific file or glob) and Componecat pulls those Markdown files in, keeping the section current as the repository changes. See Documentation sync for how to set it up.

Activity log

Section titled “Activity log”

Kinds can also enable an activity log — an append-only timeline of notes on an entity. Each entry is Markdown, timestamped, optionally attributed to a person, and can be given an expiry so time-limited notes clean themselves up. Entries can be added and removed but never edited, which makes the log a trustworthy record of what happened and when. It’s ideal for operational notes: “migrated to the new cluster,” “temporary rate limit in place until Friday.”

Section titled “Related”