Skip to content

docs: add noteMaxChars to the live-reapply runtime-signature list - #159

Merged
btspoony merged 1 commit into
omdsh-dev:mainfrom
triagmas:docs/runtime-signature-note-max-chars
Nov 17, 2026
Merged

btspoony merged 1 commit into
omdsh-dev:mainfrom
triagmas:docs/runtime-signature-note-max-chars

Conversation

@triagmas

Copy link
Copy Markdown
Contributor

Follow-up to #157 (which superseded #156): the "Live 重应用" section in docs/configuration.md enumerates the runtime-signature set as 「provider / model / systemPrompt / proseFallback / reasoningEffort」, but runtimeSignature (src/index.ts:487-489 at 97c12eb) also keys on noteMaxChars, and deliberately excludes nextPromptMaxChars (read live per prediction attempt).

The field-table row for noteMaxChars already says an edit rebuilds the session runtime; this section — the one that owns "what does a live config edit do to a running session" — said otherwise, so the same document gave both answers.

Change (docs only, one line):

  • add noteMaxChars to the signature list, after proseFallback (matching the code order);
  • state the consequence explicitly: editing it is proseFallback-class — the session runtime is rebuilt, in-flight review calls abort and the backlog is dropped;
  • state that nextPromptMaxChars is not in the signature, matching the inline comment at src/index.ts:487-488.

No code, no tests affected. Verified against src/index.ts at 97c12eb (signature array order: provider, model, systemPrompt, proseFallback, noteMaxChars, reasoningEffort).

Thanks to the mstar-inspector review on #156 (docs finding DOCS-01), which surfaced this.

@m-inspector

m-inspector Bot commented Nov 17, 2026

Copy link
Copy Markdown

✅ Verdict: ship it · Score 100% (mergeable)

Findings Count
🔴 must-fix 0
🟠 should-fix 0
🟡 may-fix 0
🔵 nit 0

📋 Review

What this PR does: Docs-only follow-up to #157 that repairs a self-contradiction in docs/configuration.md: the "Live 重应用" (live re-apply) section described the runtime-impact signature without noteMaxChars, while the field-table row for that key already said an edit rebuilds the session runtime. The section now lists the signature as provider / model / systemPrompt / proseFallback / noteMaxChars / reasoningEffort, spells out the proseFallback-class consequence (rebuild, in-flight review calls aborted, backlog dropped), and records that nextPromptMaxChars is deliberately outside the signature because the predictor reads it live per attempt. No code or tests change.

Findings

none

Revalidated findings

none

Linked-issue AC

- none — the PR links no closing issue (issues: []); it references #157 as the parent follow-up and the DOCS-01 finding from #156.
- DOCS-01 criterion from #156 (the live-signature enumeration must include noteMaxChars, matching runtimeSignature): met — docs/configuration.md live-reapply section now lists it and states the rebuild consequence, and excludes nextPromptMaxChars per the inline comment at src/index.ts.

✅ Verified

- docs/configuration.md live-reapply section now enumerates provider / model / systemPrompt / proseFallback / noteMaxChars / reasoningEffort, in that order, and states that editing noteMaxChars is proseFallback-class: runtime rebuilt, in-flight calls aborted, backlog dropped.
- The same section states nextPromptMaxChars is not in the signature and is read live per prediction attempt, matching the inline comment at the signature array in src/index.ts.
- Signature array in src/index.ts at head 132d63f matches the documented list and order (after the enabled/enabled-provider prefix), with reasoningEffort last.
- The noteMaxChars field-table row already claimed the rebuild-on-edit behavior, so the document no longer gives two answers for the same key.
- ❓ No test or CI run is evidenced: the change is docs-only and there is no executable behavior to exercise.

🗑️ Considered & rejected

- Doc drift between the field-table row and the live-reapply section — resolved by this PR; no residual contradiction found elsewhere in the file.
- Apparent omission of nextPromptMaxChars from the documented signature — rejected: the code deliberately excludes it (read live per attempt) and the doc now says so explicitly.
- Ordering mismatch between the documented list and the code array — rejected: the doc order matches the signature array order.
- Need for accompanying code or test changes — rejected: docs-only edit, runtimeSignature behavior unchanged and already covered.

🛠️ Plan to fix

none

Review 1 · commit 132d63f

@triagmas

Copy link
Copy Markdown
Contributor Author

All checks are green — validate pass (42s) and the mstar-inspector review passed with verdict ship it (100%, 0 findings). The PR is MERGEABLE.

I cannot merge it myself (external contributor: triagmas does not have the correct permissions to execute MergePullRequest) — could a maintainer merge this docs-only follow-up when convenient?

@btspoony
btspoony merged commit e1bc764 into omdsh-dev:main Nov 17, 2026
2 checks passed
@btspoony btspoony mentioned this pull request Nov 17, 2026
@triagmas
triagmas deleted the docs/runtime-signature-note-max-chars branch November 17, 2026 07:21
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.

2 participants