5 0.00 Wiki Structure and Organization
github-actions[bot] edited this page 2026-07-30 11:32:53 +00:00

Wiki Structure and Organization

The wiki uses the four documentation modes introduced in 0.-Meta-Diataxis. Numbered filenames keep the pages grouped in the GitHub Wiki and should not be renamed casually because existing links and bookmarks depend on them.

Sections

  • 0 — Meta: contribution, structure, style, and maintenance guidance.
  • 1 — Quickstarts: guided learning paths for a first successful workflow.
  • 2 — How-to guides: focused steps for completing a specific task.
  • 3 — Reference: factual descriptions of settings, APIs, shortcuts, platform differences, and supported integrations.
  • 4 — Concepts: background and mental models for understanding product behavior.

Home and _Sidebar are the navigation entry points. Each numbered section also has an index page, such as 1.00-Quickstarts, 2.00-How_To, 3.00-Reference, and 4.00-Concepts.

Adding or Updating a Page

  1. Choose the section that matches the page's purpose.
  2. Use one clear H1 and follow 0.01-Style-Guide.
  3. Link the page from its section index and from _Sidebar when it is a primary user journey.
  4. Verify commands, paths, settings, and behavior against the current repository.
  5. Follow 0.02-Wiki-QA-and-Maintenance before submitting the change.

Avoid placeholder pages and copied configuration dumps. A short maintained page with links to authoritative code or guides is preferable to a detailed page that will drift.