Skip to content

docs(readme): restructure Crate Operations, relocate AA System, replace Developer Guide#21

Open
FullGas1 wants to merge 1 commit into
developfrom
fix/doc-readme-cleanup
Open

docs(readme): restructure Crate Operations, relocate AA System, replace Developer Guide#21
FullGas1 wants to merge 1 commit into
developfrom
fix/doc-readme-cleanup

Conversation

@FullGas1

@FullGas1 FullGas1 commented Jul 11, 2026

Copy link
Copy Markdown
Collaborator

Summary

Closes lot DOC-README-CLEANUP.

  • Renames the stale # DCS-CTLD Next title to # CTLD.
  • Nests Virtual Slingload and Pack Equipt (demoted to ###) inside Crate Operations, reflecting their place under Crate Commands in the F10 menu; their Pack Vehicle/Pack FARP children demoted to ####.
  • Relocates AA System Construction to immediately follow Crate Operations.
  • Replaces the Developer Guide prose block (duplicating the published docs site) with a Documentation section linking to the pilot, mission maker, and developer guides — all three links verified live.
  • Updates the Table of Contents to match the new hierarchy; no broken anchors.
  • No src/, tests/, or build changes — docs-only lot, nothing to unit/integration test.

Test plan

  • # CTLD is the H1.
  • Table of Contents matches the rendered hierarchy, no broken anchor links.
  • Crate Operations contains Virtual Slingload and Pack Equipt as ### children.
  • AA System Construction immediately follows Crate Operations.
  • Developer Guide is gone; Documentation is present with the three links (verified resolving).
  • No other section moved, renamed, or reformatted.

See .backlog/DOC-README-CLEANUP/PRD.md and tickets/ for the full spec and vertical-slice breakdown.

🤖 Generated with Claude Code

Summary by Sourcery

Update README structure and backlog metadata to reflect the CTLD project name and improve documentation navigation.

Enhancements:

  • Add a backlog lot entry and detailed PRD/tickets describing the DOC-README-CLEANUP work, and record the change in the Unreleased section of the changelog.

Documentation:

  • Rename the README title from the temporary DCS-CTLD Next name to CTLD.
  • Restructure the Crate Operations section by nesting Virtual Slingload and Pack Equipt under it, with Pack Vehicle and Pack FARP as sub-subsections, and positioning AA System Construction immediately after Crate Operations.
  • Replace the inline Developer Guide section in the README with a Documentation section that links to the pilot, mission maker, and developer guides, and align the Table of Contents with the new hierarchy.

…ce Developer Guide (DOC-README-CLEANUP)

Renames the stale DCS-CTLD Next title to CTLD, nests Virtual Slingload and Pack Equipt under Crate Operations as a single tracer-bullet slice (moving one heading without the others and the ToC together would leave the doc temporarily inconsistent), moves AA System Construction next to Crate Operations, and swaps the outdated Developer Guide prose for direct links to the published docs site.

Tickets in .backlog/DOC-README-CLEANUP/tickets/ reflect the 3 vertical slices from a to-issues run and are marked done against this commit.
@FullGas1 FullGas1 requested a review from davidp57 as a code owner July 11, 2026 17:48
@sourcery-ai

sourcery-ai Bot commented Jul 11, 2026

Copy link
Copy Markdown

Reviewer's Guide

Docs-only PR that cleans up and restructures README content around crate operations, updates navigation, and replaces an inline developer guide with links to the external documentation, with corresponding backlog metadata and changelog entries.

Flow diagram for updated README section hierarchy

flowchart TD
  README[README]

  README --> CrateOperations[Crate Operations]
  CrateOperations --> VirtualSlingload[Virtual Slingload]
  CrateOperations --> PackEquipt[Pack Equipt]
  PackEquipt --> PackVehicle[Pack Vehicle]
  PackEquipt --> PackFARP[Pack FARP]
  CrateOperations --> AASystemConstruction[AA System Construction]

  README --> Documentation[Documentation]
  Documentation --> PilotGuide[Pilot guide]
  Documentation --> MissionMakerGuide[Mission maker guide]
  Documentation --> DeveloperDocs[Developer documentation]
Loading

File-Level Changes

Change Details Files
Retitle project and restructure README crate-related sections and navigation to reflect current workflows.
  • Renamed README H1 from "DCS-CTLD Next" to "CTLD".
  • Updated the Table of Contents to nest "Virtual Slingload" and "Pack Equipt" under "Crate Operations" and moved "AA System Construction" to follow it.
  • Demoted "Virtual Slingload" and "Pack Equipt" headings to be subsections of "Crate Operations", with "Pack Vehicle" and "Pack FARP" further demoted under "Pack Equipt".
  • Reordered crate-related feature sections (Virtual Parachute Drop, FOB, FARP, Radio Beacons, JTAC, Smoke Drop, Recon) to keep their content but match the new structural flow.
README.md
Replace inline developer build/test docs with links to the external documentation site and record the docs lot in backlog and changelog.
  • Removed the verbose "Developer Guide" section from README and replaced it with a concise "Documentation" section linking to pilot, mission maker, and developer guides (live URLs).
  • Documented the README cleanup under an "Unreleased" docs entry in CHANGELOG with a short description of title rename, crate section restructuring, and documentation link replacement.
  • Added a new backlog PRD and ticket files describing lot DOC-README-CLEANUP, including problem statement, solution, acceptance criteria, and implementation notes, and registered the lot in the backlog index table.
README.md
CHANGELOG.md
.backlog/README.md
.backlog/DOC-README-CLEANUP/PRD.md
.backlog/DOC-README-CLEANUP/tickets/01-rename-h1-title.md
.backlog/DOC-README-CLEANUP/tickets/02-replace-developer-guide-with-documentation-links.md
.backlog/DOC-README-CLEANUP/tickets/03-restructure-crate-operations-cluster.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant