Skip to content

docs: reference split into sections with a table of contents - #42

Open
Okonai wants to merge 1 commit into
mainfrom
docs/split-reference
Open

Okonai wants to merge 1 commit into
mainfrom
docs/split-reference

Conversation

@Okonai

@Okonai Okonai commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Closes #8

What

  • docs/reference.md: 27 sections in the order of the issue's list (plus Tempo and transport, Layers and groups, Sections and Cues, Show controls, Previews, App bundle and permissions, which were bullets of their own), sub-headings where one topic had several bullets (e.g. Supervisor → Crash causes, Logs, Autostart), and a table of contents.
  • Long bullets became short paragraphs (≈ 480 chars, split only at sentence ends outside code and parentheses). A sentence that is a long run of ; clauses is now a list of them, and a: x, y, z runs inside one (the right-click menus, the cards below the grid) a nested list.
  • nocturne-ctl commands by section: a table of all 110-ish commands the reference documents, each linking to its section (every entry is checked to appear in its section).
  • Ticket numbers removed from docs/: reference.md (ticket 95, 36), adr/0012-agpl-licence.md (92–95, 84), licence-notes.md headings (95, 116, 89/112, 94). Nothing linked to those headings' anchors; no links into reference.md#… existed, the README/CONTRIBUTING link to the file still works.

Every fact is still there

Built by a script that keeps each old bullet's text, only moving it under a heading and breaking it. It asserts, per old bullet, that the new text has the same words in the same order (ignoring , ; : and list markers). Across the whole file, the words only in the old one are the two (ticket N) and nine words now capitalised after a dropped label (Pairing: every… → Every… under Pairing). Easiest to review with git diff --word-diff.

Found while doing it (not fixed here, content unchanged)

  • 20 nocturne-ctl commands are not in the reference: bands, clippreview, clippreviews, fullres, fxhold, fxpilot, fxstep, fxtransition, gig, guard, listen, machine, media, modenv, movedeck, prepare, snapshot, switches, transitionparam, venues (some are described without the command name). Worth a follow-up.
  • Five sentences are still 700–970 characters, each one parenthesised list (Perform's layout, UI tests' coverage, Effects' parameter list, the first card's fields, Bezier warp modes). Breaking those needs rewording, which the issue rules out.
  • The UI section says Built-in Classic; Built-in presets for Nocturne's own effects #41 renames that header to Built-in. Whichever merges second gets the one-word fix (and Built-in presets for Nocturne's own effects #41's Presets sentence lands in the Presets section).

No build needed; docs only.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-25T12:41:35.610285Z 49715c7 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@Okonai

Okonai commented Oct 25, 2026

Copy link
Copy Markdown
Contributor Author

Regenerated on today's main (after #39, #40, #41 and #46) with the same script, now one commit. The word check still shows only the dropped (ticket N) and the capitals. One fact changed on purpose: the UI part says Built-in instead of Built-in Classic, the header's name since #41.

docs/reference.md was one bullet list with bullets of thousands of
characters. Each topic now has its own heading, under a table of
contents; long bullets are short paragraphs, and a sentence that is a
long run of clauses is a list of them. A table lists every nocturne-ctl
command the reference documents by its section. The text is the same,
word for word, less the internal ticket numbers, which are gone from
docs/ too, and the preset header's old name (Built-in Classic is now
Built-in).

Closes #8

Signed-off-by: Okonai <6979365+Okonai@users.noreply.github.com>
@Okonai
Okonai force-pushed the docs/split-reference branch from 4c1b219 to f631fbc Compare October 26, 2026 11:42
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.

Docs: split docs/reference.md into readable sections

1 participant