Skip to content

Scaffolding: docs repo governance #7

Description

@beengud

Scaffolding: docs repo governance

Suggested structure

  • Keep only user-facing docs; versioned under versions/<release>/ with latest symlink.
  • Top-level README.md describing navigation + contribution rules.
  • STYLE.md for voice, formatting, code fences.

Automation to add

  • GitHub Action: docs-lint.yml (markdownlint, link checker, front-matter validator).
  • Phage policy: enforce versioned docs, forbid archive/ folders, ensure landing page exists.
  • Branch protection: require docs-lint + link-check statuses.

Cleanup tasks

  • Delete archived/AI-dump folders; move any keepers into versions/vNEXT.
  • Add versions.json manifest with latest tag pointer.
  • Add docs/STRUCTURE.md and docs/CONTRIBUTING.md.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions