documentation

name	documentation
description	Update code2prompt documentation when public behavior or architecture changes.

Documentation

Update docs when a change affects public APIs, CLI flags/defaults/output, configuration, template variables, feature flags, installation, or user workflows.

• Use //! for module purpose and boundaries.
• Use /// for useful public API semantics, errors, or examples.
• Use inline comments only for non-obvious intent, constraints, or tradeoffs.
• Keep the root README, Python README, and website examples consistent with their surface.
• Update localized pages when in scope; otherwise report which copies may be stale.

Do not add comments that merely restate the code.

For changed CLI documentation, compare against:

cargo run --quiet -- --help

Run the relevant verification skill after documentation-sensitive changes.