Quick Start & Setup Guide
Relevant source files
The following files were used as context for generating this wiki page:
The Quick Start & Setup Guide provides the essential procedures for initializing and configuring the ATMOS Project Wiki system. This module is designed to empower Code Agents to perform deep research into a codebase and generate structured, Markdown-based documentation stored within the .atmos/wiki/ directory.
The scope of this guide covers the initial invocation of the wiki generation skill, the mandatory validation gates required for a complete setup, and the integration of the resulting wiki into the ATMOS frontend. By following these steps, developers can transition from a raw codebase to a "research-grade" documentation set that includes architectural diagrams, technical deep dives, and getting-started guides for newcomers. Sources: skills/project-wiki/README.md:1-15, skills/project-wiki/SKILL.md:1-15
Core Invocation & Mandatory Workflow
To start the wiki generation process, a developer must invoke the project-wiki skill via a supported Code Agent. The system follows a strict multi-step workflow enforced by a mandatory checklist.
Initial Invocation
The process begins by calling the skill through an agent interface such as Claude Code, Codex, or Cursor. Sources: skills/project-wiki/README.md:38-45
| Agent | Command Example |
|---|---|
| Claude Code | claude "Generate project wiki using the project-wiki skill" |
| Codex | codex "Create a comprehensive wiki for this project with the project-wiki skill" |
Setup Workflow Steps
The following diagram illustrates the sequence of operations required to move from an undocumented project to a validated wiki.
Sources: skills/project-wiki/SKILL.md:27-100
Environment Preparation
Before content can be generated, the environment must be initialized with metadata and tracking files.
- Initialize TODO Tracking: Run
init_wiki_todo.shfrom the project root. This creates.atmos/wiki/_todo.md, which serves as the source of truth for the generation progress. Sources: skills/project-wiki/SKILL.md:33-40 - Metadata Collection: Execute
collect_metadata.sh. This script populates.atmos/wiki/_metadata/with Git logs, contributor lists, and PR/Issue data (if theghCLI is available). These artifacts are critical for the agent to understand design intent and evolution. Sources: skills/project-wiki/SKILL.md:46-55, skills/project-wiki/references/output_structure.md:12-20
Catalog & Document Structure Setup
The wiki is organized into two primary sections: Getting Started (for newcomers) and Deep Dive (for maintainers). This structure is defined in the _catalog.json file.
Required Catalog Metadata
The _catalog.json must adhere to a specific schema to be valid. Sources: skills/project-wiki/SKILL.md:135-160, skills/project-wiki/references/output_structure.md:65-85
| Field | Description | Requirement |
|---|---|---|
version | Format version (e.g., "2.0") | Required |
project | Object containing name and description | Required |
commit_hash | The current HEAD commit hash | Required |
catalog | Hierarchical array of sections and articles | Required |
Document Frontmatter Template
Every Markdown document must start with strict YAML frontmatter. Failure to use this exact format will cause rendering errors in the frontend. Sources: skills/project-wiki/references/output_structure.md:118-140
---
title: Article Title
section: getting-started
level: beginner
reading_time: 5
path: getting-started/overview
sources:
- src/main.rs
updated_at: 2026-02-11T12:00:00Z
---
Frontend Integration Setup
Integrating the generated wiki into the ATMOS frontend requires reading the catalog and rendering the Markdown files with support for Mermaid diagrams. Sources: skills/project-wiki/references/frontend-integration.md:5-15
Setup Requirements for Rendering
The frontend must be equipped with libraries to handle GFM and diagrams. Sources: skills/project-wiki/references/frontend-integration.md:65-75
- Markdown Rendering:
react-markdownwithremark-gfm. - Diagrams:
mermaidormdx-mermaidto detectlanguage-mermaidblocks. - Syntax Highlighting:
prism-react-rendererorhighlight.js.
Validation Gates (Final Step)
The setup is not considered complete until all validation scripts pass. These scripts ensure that the generated content meets the project's "research-grade" standards. Sources: skills/project-wiki/SKILL.md:280-315
- Catalog Validation:
python3 scripts/validate_catalog.py .atmos/wiki/_catalog.jsonchecks hierarchy and required fields. - Frontmatter Validation:
python3 scripts/validate_frontmatter.py .atmos/wiki/ensures strict YAML compliance. - Content Depth Validation:
python3 scripts/validate_content.py .atmos/wiki/verifies word counts (800+ for Getting Started, 1500+ for Deep Dive) and the presence of Mermaid diagrams (2-3+ per article). Sources: skills/project-wiki/README.md:120-135
The Quick Start & Setup Guide ensures a standardized foundation for codebase documentation. By adhering to the mandatory research workflow and validation scripts, developers ensure the resulting wiki is portable, accurate, and deeply integrated with the project's evolution. Sources: skills/project-wiki/SKILL.md:345-355