Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions .backlog/DOC-README-CLEANUP/PRD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
Status: waiting-human

# PRD — DOC-README-CLEANUP

## Problem Statement

The project README.md has accumulated several structural and naming issues since the codebase moved
from the temporary `DCS-CTLD Next` repository to the definitive `CTLD` repository:

1. The document title still reads `DCS-CTLD Next`, the old temporary repo name.
2. Two sections (`Pack Equipt` and `Virtual Slingload`) are presented at the same hierarchy level
as `Crate Operations`, even though both are crate sub-operations and already appear under
**Crate Commands** in the F10 menu description.
3. `AA System Construction` is placed far from `Crate Operations` despite being a multi-crate
assembly workflow.
4. The `Developer Guide` section is a self-contained prose block that duplicates content now
published on the documentation site, with no links to the live guides.

## Solution

Apply six targeted edits to `README.md`:

1. Rename the H1 title from `DCS-CTLD Next` to `CTLD`.
2. Demote `## Pack Equipt` to `### Pack Equipt` and move it inside `## Crate Operations`
(after the Unpack paragraph), reflecting its position under Crate Commands in the F10 menu.
3. Demote `## Virtual Slingload` to `### Virtual Slingload` and move it inside
`## Crate Operations` (after the Drop paragraph, before Pack Equipt), for the same reason.
4. Keep `## AA System Construction` at `##` level but relocate it to immediately after
`## Crate Operations` to signal the logical proximity.
5. Update the Table of Contents to reflect changes 1–4.
6. Replace `## Developer Guide` with a `## Documentation` section containing three quick links
to the live documentation site (pilot guide, mission maker guide, developer documentation).

## User Stories

1. As a new user landing on the GitHub repository page, I want the README title to say `CTLD` so
that I immediately know I am in the right repository and not a stale fork.
2. As a mission maker reading the README, I want `Pack Equipt` to appear inside `Crate Operations`
so that I understand packing is part of the crate lifecycle, not a standalone concept.
3. As a mission maker reading the README, I want `Virtual Slingload` to appear inside
`Crate Operations` so that I find slingload documentation in the same place as crate loading
and dropping.
4. As a mission maker reading the README, I want `AA System Construction` to appear immediately
after `Crate Operations` so that the connection between crate assembly and AA system build
is obvious without scrolling far.
5. As a developer consulting the README, I want the Table of Contents to accurately reflect the
section hierarchy so that anchor links work and navigation is predictable.
6. As any reader consulting the README, I want a `Documentation` section with direct links to
the pilot guide, mission maker guide, and developer documentation site so that I can reach
the full reference without searching.

## Implementation Decisions

- All changes are confined to `README.md`. No source file, test, or build artifact is modified.
- The three subsections of `## Crate Operations` after the edit will be, in order:
`### Virtual Slingload`, then `### Pack Equipt`. The existing `### Pack Vehicle` and
`### Pack FARP` headings inside Pack Equipt become `####`.
- `## Virtual Parachute Drop` and `## FARP Deployment` are left at `##` level in their current
positions: both are cross-cutting (Troop / Vehicle / Crate Commands) and their standalone
status is justified.
- The `## Documentation` quick-link section uses the production URLs below (English, consistent
with the rest of the README):
- Pilot guide: `https://veaf.github.io/CTLD/dev/pilot/`
- Mission maker guide: `https://veaf.github.io/CTLD/dev/mission-maker/`
- Developer documentation: `https://veaf.github.io/CTLD/dev/developer/`

## Testing Decisions

This lot contains no logic changes. There is nothing to unit-test or integration-test.

Acceptance criteria (manual review checklist):
- [ ] H1 reads `# CTLD`.
- [ ] Table of Contents reflects the new hierarchy (no broken anchor links).
- [ ] `Crate Operations` section contains `Virtual Slingload` and `Pack Equipt` as `###` children.
- [ ] `AA System Construction` immediately follows `Crate Operations` in the rendered document.
- [ ] `Developer Guide` section is gone; `Documentation` section is present with the three links.
- [ ] No other section has been moved, renamed, or reformatted.

## Out of Scope

- Content edits inside any section (wording, examples, parameters).
- Restructuring sections other than those listed above.
- Adding new documentation pages or updating the docs site itself.
- Any `src/` or `tests/` changes.

## Further Notes

The URLs supplied for the `## Documentation` section point to the `dev/` subdirectory of the
GitHub Pages site deployed by `DOC-MKDOCS`. Verify the links resolve correctly before merging.
23 changes: 23 additions & 0 deletions .backlog/DOC-README-CLEANUP/tickets/01-rename-h1-title.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# 01 — Rename the README title from `DCS-CTLD Next` to `CTLD`

Status: done
Type: AFK

## What to build

Rename the H1 title in `README.md` from `# DCS-CTLD Next` to `# CTLD`, the old temporary repo
name left over from the `DCS-CTLD Next` repository. Self-contained: the H1 is not referenced from
the Table of Contents, so this slice has no knock-on effect elsewhere in the document.

## Acceptance criteria

- [x] `README.md` line 1 reads `# CTLD`.
- [x] No other text on that line or the subtitle below it is changed.

## Blocked by

None - can start immediately.

## Implementation

Done in commit `1d528dd` on `fix/doc-readme-cleanup`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# 02 — Replace `Developer Guide` with a `Documentation` quick-links section

Status: done
Type: AFK

## What to build

Replace the `## Developer Guide` prose block (which duplicates content already published on the
documentation site) with a `## Documentation` section containing three quick links:

- Pilot guide: `https://veaf.github.io/CTLD/dev/pilot/`
- Mission maker guide: `https://veaf.github.io/CTLD/dev/mission-maker/`
- Developer documentation: `https://veaf.github.io/CTLD/dev/developer/`

Self-contained: this only touches the last `## Developer Guide` / `## Documentation` heading and
its own single line in the Table of Contents — independent of the Crate Operations cluster
restructured in ticket 03.

## Acceptance criteria

- [x] `## Developer Guide` no longer exists in `README.md`.
- [x] `## Documentation` exists in its place with the three links above.
- [x] All three links resolve correctly (verified live — pilot/mission-maker/developer guide pages
load with the expected headings).
- [x] The Table of Contents entry for this section is updated accordingly.

## Blocked by

None - can start immediately.

## Implementation

Done in commit `1d528dd` on `fix/doc-readme-cleanup`. Links verified live via WebFetch before
merging (all three resolve to their respective guide pages).
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# 03 — Restructure the Crate Operations cluster

Status: done
Type: AFK

## What to build

Nest `Virtual Slingload` and `Pack Equipt` inside `Crate Operations` as `###` children, relocate
`AA System Construction` to immediately follow `Crate Operations`, and update every Table of
Contents entry touched by this move — all in the same change. This is kept as a single vertical
slice rather than split by heading: moving one section without updating the ToC and the sibling
moves in the same commit would leave the document's navigation temporarily inconsistent, which
fails the "no broken anchor links" / "ToC reflects the new hierarchy" acceptance bar. The slice is
independent of tickets 01 and 02.

Resulting structure:

- `## Crate Operations`
- Spawn / Load / Drop paragraphs (unchanged)
- `### Virtual Slingload` (demoted from `##`, moved here after the Drop paragraph)
- Unpack paragraph (unchanged)
- `### Pack Equipt` (demoted from `##`, moved here after the Unpack paragraph)
- `#### Pack Vehicle` (demoted from `###`)
- `#### Pack FARP` (demoted from `###`)
- `## AA System Construction` (kept at `##`, relocated to immediately follow `Crate Operations`)

`## Virtual Parachute Drop` and `## FARP Deployment` are left in place — both are cross-cutting
(Troop / Vehicle / Crate Commands) and out of scope for this move.

## Acceptance criteria

- [x] `## Virtual Slingload` and `## Pack Equipt` no longer exist as standalone `##` sections.
- [x] `### Virtual Slingload` then `### Pack Equipt` appear inside `## Crate Operations`, in that
order.
- [x] `#### Pack Vehicle` and `#### Pack FARP` are nested under `### Pack Equipt`.
- [x] `## AA System Construction` immediately follows `## Crate Operations` in the rendered
document, and remains at `##` level with its content unchanged.
- [x] `## Virtual Parachute Drop` and `## FARP Deployment` stay at `##` level, untouched.
- [x] Table of Contents entries and nesting match the rendered hierarchy exactly; no broken anchor
links.
- [x] No section body text is changed (only heading levels and position move).

## Blocked by

None - can start immediately.

## Implementation

Done in commit `1d528dd` on `fix/doc-readme-cleanup`.
2 changes: 1 addition & 1 deletion .backlog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ authored **per lot, when the lot is started** (not in batch).

| Lot | Status | Description | Branch |
|-----|--------|-------------|--------|
| _(none)_ | | | |
| `DOC-README-CLEANUP` | 🧑 waiting-human | Fix README title, restructure Crate Operations sub-sections, relocate AA System Construction, replace Developer Guide with Documentation links — implemented, pending PR review/merge | `fix/doc-readme-cleanup` |

### Planned lots

Expand Down
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ Versioning follows [Semantic Versioning](https://semver.org/).

## [Unreleased]

### Docs — README cleanup

- **Fix**: README H1 renamed from the stale `DCS-CTLD Next` temporary-repo title to `CTLD`.
- **Restructure**: `Pack Equipt` and `Virtual Slingload` demoted from `##` to `###` and moved
inside `Crate Operations` (their parent workflow, and already grouped under **Crate Commands**
in the F10 menu); `AA System Construction` relocated to immediately follow `Crate Operations`.
- **Restructure**: `Developer Guide` (a prose block duplicating the published docs site) replaced
by a `Documentation` section linking directly to the pilot, mission maker and developer guides.
- Table of Contents updated to match the new section hierarchy.

### DCS integration testing — first live validation

- **Fix**: `missions/Test_CTLDNEXT_01.miz`'s embedded `beacon.ogg` (420KB) broke the DCS Mission
Expand Down
Loading