Swift Onboard: Architecture Documentation

Generate or update your project's ARCHITECTURE.md with a high-level system overview.

Tool Usage

scripts/swift_onboard

Gotchas

• The tool scans the current working directory — make sure you're in the project root before running.
• If the project already has an ARCHITECTURE.md, the tool will update it rather than overwrite. Review the diff after generation.
• For large projects, the initial scan may take time. The output quality depends on the codebase's structural clarity — heavily nested or unconventional layouts may need manual supplementation.

Workflow

1. Orient: Navigate to the project root and run scripts/swift_onboard
2. Review: Read the generated ARCHITECTURE.md to understand core components and entry points
3. Supplement: Add any domain-specific context the tool couldn't infer automatically
4. Maintain: Re-run after significant structural changes to keep documentation current