Skip to content

Documentation Cleanup & Versioning #5

Description

@beengud

Documentation Cleanup & Versioning

Goals

  • Remove dated/archived content; delete archive/ or similar folders
  • Trim AI conversation dumps; keep only user-facing docs
  • Establish versioned docs (e.g., docs/versions/ with vX directories) aligned to releases
  • Ensure README points to canonical docs and quickstart
  • Add doc lint/check to CI (failing on orphaned files or unversioned changes)

Tasks

  • Delete archive/ or other legacy folders; migrate anything still needed into versioned docs
  • Remove redundant AI logs/notes; keep distilled guides only
  • Create docs/versions/vNEXT seeded from current docs; document versioning policy
  • Add docs/STRUCTURE.md describing required sections (intro, install, usage, API, changelog links)
  • Wire doc check into CI (validate structure + broken links)
  • Update README to reference versioned docs and housekeeping guidelines

Acceptance Criteria

  • No archived/dated folders remain
  • Docs pass link/structure check in CI
  • Versioned docs directory exists and is referenced from README

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