Skip to content

[Audit] Documentation Consolidation - Reduce Duplication Across Docs #904

New issue
New issue
Closed
AI Ops
0 of 2 issues completed
#1451
Closed
[Audit] Documentation Consolidation - Reduce Duplication Across Docs#904
AI Ops
0 of 2 issues completed
#1451
Assignees
ashleyshaw
Labels
area:documentationmigrate:area:documentationDocs & guidesmigrate:priority:importantMust-do high prioritymigrate:type:auditAuditpriority:importanttype:audit
Milestone
v1.2

Description

@ashleyshaw
ashleyshaw
opened on Jun 8, 2026

Overview

Audit and consolidate overlapping documentation across docs/, .github/, and instructions/ to reduce duplication and improve maintainability.

In-Scope

  • Identify duplicate and conflicting guidance across issue, PR, labelling, and automation docs
  • Define canonical source files and cross-link strategy
  • Propose archive/migration targets for obsolete docs
  • Update index and discoverability paths

Out-of-Scope

  • Rewriting all documentation in this issue
  • Refactors unrelated to documentation location and quality

Current Problems

  1. Multiple files cover the same topics with divergence.
  2. Cross-references are inconsistent.
  3. Canonical placement is unclear in some areas.
  4. Index completeness and navigation quality are uneven.

Acceptance Criteria

  • Duplication map completed
  • Consolidation strategy defined by topic
  • Archive/migration candidates identified
  • Cross-reference/linking strategy documented

Deliverables

  • Consolidation matrix
  • Canonical doc map
  • Archive candidate list
  • Follow-up implementation tasks

Related Files

  • docs/
  • docs/index.md
  • .github/README.md
  • README.md
  • instructions/

Definition of Ready (DoR)

  • Audit scope, checklist, and goals defined
  • Areas/components listed
  • Dependencies and standards mapped

Definition of Done (DoD)

  • Audit performed and findings documented
  • Remediation actions assigned
  • Documentation/changelog updated (if applicable)
  • PR uses correct branch prefix (audit/)

Activity

  1. ashleyshaw
    added
    migrate:priority:importantMust-do high priority
    migrate:status:needs-triageNeeds triage
    migrate:type:auditAudit
    migrate:area:documentationDocs & guides
    on Jun 8, 2026

  2. linear-code commented on Jun 8, 2026

    @linear-code
    linear-codeBot
    on Jun 8, 2026 – with Linear Code

    LS-968

    LS-1054

  3. github-actions commented on Jun 8, 2026

    @github-actions
    github-actionsBot
    on Jun 8, 2026 – with GitHub Actions
    Contributor

    ✅ Template check passed after update. Thanks for fixing the issue body.

  4. github-actions
    closed this as not plannedon Jun 8, 2026
  5. ashleyshaw
    reopened this on Jun 18, 2026
  6. github-actions
    closed this as not plannedon Jun 18, 2026
  7. ashleyshaw
    reopened this on Jun 19, 2026
  8. github-actions
    added
    migrate:status:needs-more-infoMissing details to proceed
    and removed
    migrate:status:needs-triageNeeds triage
    on Jun 19, 2026
  9. github-actions
    assigned
    ashleyshaw
    on Jun 19, 2026
  10. github-actions
    added this to the milestone on Jun 19, 2026
  11. ashleyshaw
    added the
    AI Ops
    issue type on Jun 19, 2026
  12. ashleyshaw
    set
    Priority
    to
    High
    on Jun 19, 2026
  13. ashleyshaw
    added sub-issues on Jun 19, 2026
  14. github-actions
    removed
    migrate:status:needs-more-infoMissing details to proceed
    on Jun 19, 2026
  15. ashleyshaw
    modified the milestones: , v1.2 on Jul 22, 2026
  16. ashleyshaw
    added 2 commits that reference this issue on Jul 31, 2026

    docs(wave-5): create Batch 1 GitHub issue rewrite execution files

    e290484

    refactor: Phase 1 repository restructuring — folder consolidation (#1446

    aca901b

  17. ashleyshaw commented on Jul 31, 2026

    @ashleyshaw
    ashleyshaw
    on Jul 31, 2026
    MemberAuthor

    Phase 3 Execution Planning Complete

    ✅ PR #1451 created with complete Phase 3 execution planning:

    Deliverables

    Timeline

    • Phase 3A: Aug 1–4 (Archival & File Organization)
    • Phase 3B: Aug 6–11 (Documentation Consolidation) ← Parent issue
    • Phase 3C: Aug 6–10 (Accuracy Verification, parallel)
    • Phase 3D: Aug 12–16 (Documentation Index)
    • Phase 3E: Aug 17–21 (Project Closure)

    Next Steps

    1. Merge PR [Wave 5 Phase 3] Documentation Update Strategy & Execution Planning #1451
    2. Execute Batch 1 dry-run on Aug 4
    3. Begin Phase 3A on Aug 1

    Full PR: #1451

  18. ashleyshaw
    closed this as completedin #1451on Jul 31, 2026

  19. github-actions commented on Jul 31, 2026

    @github-actions
    github-actionsBot
    on Jul 31, 2026 – with GitHub Actions
    Contributor

    ✅ Issue checklists finalised after closure.

  20. linear-code
    added
    priority:important
    type:audit
    area:documentation
    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

Labels

area:documentationmigrate:area:documentationDocs & guidesmigrate:priority:importantMust-do high prioritymigrate:type:auditAuditpriority:importanttype:audit

Type

AI Ops

Fields

Priority

High

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions