Repository navigation
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
3 tasks
Okonai
force-pushed
the
docs/split-reference
branch
from
October 25, 2026 14:47
49715c7 to
4c1b219
Compare
Contributor
Author
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
force-pushed
the
docs/split-reference
branch
from
October 26, 2026 11:42
4c1b219 to
f631fbc
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.;clauses is now a list of them, anda: x, y, zruns inside one (the right-click menus, the cards below the grid) a nested list.nocturne-ctlcommands 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).docs/:reference.md(ticket 95, 36),adr/0012-agpl-licence.md(92–95, 84),licence-notes.mdheadings (95, 116, 89/112, 94). Nothing linked to those headings' anchors; no links intoreference.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 withgit diff --word-diff.Found while doing it (not fixed here, content unchanged)
nocturne-ctlcommands 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.No build needed; docs only.
Need help on this PR? Tag
@codesmith-botwith what you need.