Skip to content

Enforce consistent documentation formatting for generated help/quickstart docs #419

Description

@KooshaPari

Summary

Standardize generated help and quickstart documentation formatting so outputs are consistent, parseable, and easy to maintain.

Related PRs

  • None yet

Acceptance Criteria

  • Define the canonical formatting contract (sections, heading levels, spacing, code blocks, examples).
  • Apply formatter/template updates to generation path(s) for help and quickstart outputs.
  • Add snapshot/format tests to guard against regressions in generated docs.
  • Normalize line endings, list formatting, and command examples.
  • Add contribution guidance for authors editing generation templates or related scripts.

Metadata

Metadata

Assignees

No one assigned

    Labels

    staleNo recent activity; may no longer be relevant

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions