Skip to content

[Child of #651] Audit: Documentation Folder Structure vs. CLAUDE.md Boundaries #665

Open

Description

@ashleyshaw

Overview

Audit current documentation folder organization against the planned structure in CLAUDE.md to identify misplacements and reorganization needs.

Scope

  • Review current structure of docs/, .github/, instructions/, and related folders
  • Compare against CLAUDE.md guidance for where documentation should live
  • Identify misplaced files
  • Identify missing documentation
  • Propose reorganization plan with rationale

Audit Checklist

  • Extract current documentation file structure
  • Review CLAUDE.md repository boundaries section
  • Create mapping: Current Location → Expected Location
  • Identify files in wrong folder
  • Identify folders that need to be created
  • Identify files that should be merged or archived
  • Document rationale for any reorganization
  • Create migration plan with dependencies

Deliverables

  • Current state documentation inventory
  • Mapping table: File | Current Location | Expected Location (per CLAUDE.md) | Action
  • Reorganization proposal with rationale
  • Migration plan with step-by-step instructions
  • Impact assessment (what breaks if we move X?)

Related Files

  • CLAUDE.md (source of truth)
  • docs/ (all files)
  • .github/ (all subfolders)
  • instructions/ (all files)
  • README.md (root)

Related Documentation


Definition of Ready (DoR)

  • Clear problem statement and expected outcome
  • Acceptance criteria defined
  • Related issues/dependencies identified
  • Required resources/approvals listed

Definition of Done (DoD)

  • All acceptance criteria met
  • Changes tested and validated
  • Documentation updated
  • Changes merged and deployed
  • Stakeholders notified

Activity

  1. linear-code commented on May 31, 2026

    @linear-code
  2. 14 remaining items

  3. ashleyshaw commented on Jun 3, 2026

    @ashleyshaw
    MemberAuthor

    Status update (2026-06-03): Changes affecting this issue are now merged into develop via PR #814 (commit ea285b6). Current issue state remains as-is and reflects the delivered work.

  4. github-actions commented on Jun 19, 2026

    @github-actions
    Contributor

    ⚠️ This issue does not follow a required issue template.

    Missing required section(s): Definition of Ready (DoR), Definition of Done (DoD)

    The issue will remain open and flagged until the body is corrected.
    Please update the issue with one of the official templates:

    If this was opened by automation, update the automation to preserve the template sections before creating the issue.

  5. modified the milestones: , v1.2, v1.1 on Jul 22, 2026
  6. self-assigned this
    on Sep 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

Fields

Priority

None yet

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions