59 docs tagged with "doc-gen"

Quick CLI, path, option, and safety reference.

Diagnose configuration, target, environment, and workflow failures.

Understand how Doc Gen resolves structure detail, adapts to repositories, and protects project files.

Configuration: doc-gen init

Configuration: doc-gen structure analyze

Configuration: doc-gen structure generate

Configuration: doc-gen structure print

Understand the project configuration file, precedence, and active sections.

Prepare a focused, tested, documented, and safe Doc Gen contribution.

Install Doc Gen in editable mode and configure its pre-commit contributor workflow.

Pull Doc Gen production images with immutable or moving stable tags and run the CLI in a container.

Examples: doc-gen init

Examples: doc-gen structure analyze

Examples: doc-gen structure generate

Examples: doc-gen structure print

Understand responsibilities and execution flow.

FAQ: doc-gen init

FAQ: doc-gen structure analyze

FAQ: doc-gen structure generate

FAQ: doc-gen structure print

Install the CLI, initialize project configuration, and run a safe first workflow.

Options: doc-gen init

Options: doc-gen structure analyze

Options: doc-gen structure generate

Options: doc-gen structure print

Output: doc-gen init

Output: doc-gen structure analyze

Output: doc-gen structure generate

Output: doc-gen structure print

Understand responsibilities and execution flow.

Create the project-owned Doc Gen configuration file.

Inspect repository characteristics and resolved structure settings without writing project documentation.

Scan a repository, render its tree as Markdown, and write only the resolved output document.

Scan and render a project tree directly in the terminal without creating a Markdown document.

Understand the project configuration file, precedence, and active sections.

Understand Doc Gen's contributor workflow, output boundaries, and quality tools.

Install the CLI, initialize project configuration, and run a safe first workflow.

Quick CLI, path, option, and safety reference.

Diagnose configuration, target, environment, and workflow failures.

Choose a workflow by its target and side effects.

Choose a workflow by its target and side effects.

A writable target project. Python 3.9+ package compatibility; Python 3.14 is the standard runtime. Review .config/doc_gen before --force.

A readable target directory. Enough access to inspect repository entries. Appropriate ignore rules for large/generated directories.

A readable target directory. A writable output parent for live generation. An output path that does not identify unrelated documentation.

A readable target directory. A terminal capable of displaying the rendered tree. Profile/depth settings suitable for repository size.

Generate, print, or analyze a repository tree.

Syntax: doc-gen init

Syntax: doc-gen structure analyze

Syntax: doc-gen structure generate

Syntax: doc-gen structure print

Test Doc Gen initialization, structure commands, output boundaries, and dry-run behavior.

Troubleshooting: doc-gen init

Troubleshooting: doc-gen structure analyze

Troubleshooting: doc-gen structure generate

Troubleshooting: doc-gen structure print

Workflow: doc-gen init

Workflow: doc-gen structure analyze

Workflow: doc-gen structure generate

Workflow: doc-gen structure print