Skip to content

Onboarding

TeamWiki is a docs-as-code knowledge base. You do not need to edit site internals to add knowledge.

  1. Pick a template from templates/.
  2. Copy it under src/content/docs/knowledge/.
  3. Fill in frontmatter and required sections.
  4. Run validation and index generation:
Terminal window
python3 scripts/teamwiki.py validate
python3 scripts/teamwiki.py generate
  1. Open a pull request and use the knowledge review checklist.
  • Is the entry accurate relative to the source evidence?
  • Would it help a teammate solve a similar problem faster?
  • Are project, tool, tag, and problem-type metadata useful?
  • Are private details and secrets removed?
  • Can an AI answer cite the original source path?