Skip to content

feat(standard): add §8 Documentation (Texinfo) — v1.24#5

Merged
UnbreakableMJ merged 2 commits into
mainfrom
add-texinfo-documentation-section
Jun 18, 2026
Merged

feat(standard): add §8 Documentation (Texinfo) — v1.24#5
UnbreakableMJ merged 2 commits into
mainfrom
add-texinfo-documentation-section

Conversation

@UnbreakableMJ

Copy link
Copy Markdown
Contributor

Summary

  • Adds §8 — Documentation (Texinfo) as a new top-level section, establishing Texinfo as the first-class technical manual format for Spacecraft Software user-facing projects, following GNU project conventions
  • §8.1: MUST for CLI/TUI/GUI apps; SHOULD for libraries; MAY skip for scripts
  • §8.2: doc/<project>.texi, Makefile info/html/pdf targets
  • §8.3: Required structural elements (@dircategory, @copying, @titlepage, @node Top, @menu)
  • §8.4: .info / .html / .pdf outputs; install-info at package install time
  • §8.5: CC-BY-SA-4.0 default; GFDL-1.3-or-later permitted for GPL software
  • §8.6: Packaging integration (Guix/Nix/PKGBUILD)
  • Renumbers old §8–§15 → §9–§16 throughout (headers, body cross-references, compliance checklist, Skill Cross-References table)
  • Adds §8 bullet to the compliance checklist (now §16)
  • Fixes §13 UI/UX cross-reference to color palette (§10→§11 after renumber)
  • Bumps to v1.24 / 2026-06-19

Test plan

  • All section headers §1–§16 present and in order (grep "^## §")
  • §8 content complete (§8.1–§8.6)
  • No stale §13 body references outside the §13 UI/UX section
  • No stale §14.x references outside the §14 Date/Time section
  • Compliance checklist has 15 normative bullets + §6.3 signing bullet
  • Skill Cross-References table includes Texinfo row
  • v1.24 changelog entry at top of §1

🤖 Generated with Claude Code

UnbreakableMJ and others added 2 commits June 19, 2026 02:28
Texinfo as first-class technical manual format for user-facing Spacecraft
Software projects, following GNU project conventions:

- §8.1: MUST for CLI/TUI/GUI apps, SHOULD for libraries, MAY skip for scripts
- §8.2: doc/<project>.texi, Makefile targets (info/html/pdf)
- §8.3: required structural elements (@dircategory, @copying, @TitlePage, etc.)
- §8.4: .info / .html / .pdf outputs; install-info at package install time
- §8.5: CC-BY-SA-4.0 default; GFDL-1.3-or-later permitted for GPL software
- §8.6: packaging integration (Guix/Nix/PKGBUILD)

Renumber old §8–§15 → §9–§16 throughout (headers, cross-references,
compliance checklist, Skill Cross-References table). Add §8 checklist bullet.
Update CLAUDE.md section-number references in same change-set.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
After inserting §8 and renumbering, the §13 UI/UX body still referenced
the old §10 (now §10 Key Bindings). Corrected to §11 (Spacecraft Software
Color Palette).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@UnbreakableMJ UnbreakableMJ merged commit 9e2d3ed into main Jun 18, 2026
1 check passed
@UnbreakableMJ UnbreakableMJ deleted the add-texinfo-documentation-section branch June 18, 2026 23:36
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