67 lines (48 loc) · 1.52 KB

Developer Getting Started

This guide helps developers start working on DocGen quickly and safely.

1) Clone and Enter Repository

git clone https://github.com/devalltect00/doc-gen.git
cd doc-gen

2) Create Environment and Install Dependencies

Use Python 3.14 for the standard development environment and quality tools:

python -m venv .venv
.venv\Scripts\activate
pip install -e ".[dev]"

For a compatibility-test environment such as Python 3.9, install only the runtime-compatible test dependencies:

pip install -e ".[test]"
make test-ci

3) Validate Local Setup

doc-gen --help
python -m doc_gen --help

4) Run Initialization and Sample Generation

doc-gen init
doc-gen structure generate

5) Run Tests and Lint Checks

make check-ci

6) Main Code Map

CLI entrypoint: app/doc_gen/cli/main.py
Init command: app/doc_gen/cli/commands/init/command.py
Structure commands: app/doc_gen/cli/commands/structure/
Core structure engine: app/doc_gen/core/structure/
Scanner service: app/doc_gen/core/structure/scanner/
Generator service: app/doc_gen/core/structure/generator/
Tests: tests/

7) Development Safety Checklist

Run print command before generate to preview output
Keep docs aligned with real code behavior
Confirm tests pass before finalizing
Avoid changing protected docs unless explicitly requested