smart docs

Documentation Community

Skill notes

Core Principles

Progressive Analysis: Analyze codebases incrementally, not all at once Pattern Recognition: Identify common architectural patterns C4 Model: Structure documentation following C4 model levels Mermaid Diagrams: Use Mermaid for all visualizations Markdown Output: Generate well-structured markdown files

Phase 1: Project Discovery (5-10 minutes)

Objective: Understand project structure, technology stack, and scope Steps: Get Project Overview: Count Lines of Code: Identify Entry Points:

Phase 2: Architecture Analysis (10-20 minutes)

Objective: Understand system architecture, modules, and relationships Steps: Identify Modules/Packages: Rust: src/ subdirectories, Cargo.toml workspace members Python: Top-level directories with __init__.py

Phase 3: Documentation Generation (20-40 minutes)

Objective: Create comprehensive markdown documentation Create ./docs/ directory structure: Document 1: Project Overview.md Content Structure: [Directory tree of main components]

Phase 4: Diagram Generation (10-15 minutes)

Mermaid Diagram Types to Use: System Context - C4Context (use C4 plugin syntax if available, otherwise use graph) Container Diagram - C4Container or deployment diagram Component Relationships - Graph TB/LR Sequence Diagrams - For workflows

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Documentation
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
85 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@sopaco · no license declared
Token usage
Lean
Setup complexity
Guided setup
External API key
Not required
Operating systems
macOS · Linux · Windows
Runtime requirements
Node.js · Python
Detected file/system behavior
  • Read-only
  • Write / modify
Network behavior
External requests
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.; The upstream repository has not been updated for 206 days and may not match current agent behavior.

01
Phase 1: Project Discovery (5-10 minutes)

Objective: Understand project structure, technology stack, and scope Steps: Get Project Overview: Count Lines of Code: Identify Entry Points:

02
Phase 2: Architecture Analysis (10-20 minutes)

Objective: Understand system architecture, modules, and relationships Steps: Identify Modules/Packages: Rust: `src/` subdirectories, `Cargo.toml` workspace members Python: Top-level directories with `__init__.py`

03
Phase 3: Documentation Generation (20-40 minutes)

Objective: Create comprehensive markdown documentation Create `./docs/` directory structure: Document 1: Project Overview.md Content Structure: [Directory tree of main components]

04
Phase 4: Diagram Generation (10-15 minutes)

Mermaid Diagram Types to Use: System Context - C4Context (use C4 plugin syntax if available, otherwise use graph) Container Diagram - C4Container or deployment diagram Component Relationships - Graph TB/LR Sequence Diagrams - For workflows

05
Phase 5: Quality Assurance (5-10 minutes)

Checklist: [ ] All markdown files created [ ] Mermaid syntax validated [ ] Cross-references work [ ] File structure logical

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.