Skip to content

docs: keep each edit and Code Mode fact in one place - #222

Merged
sergej-koscejev merged 2 commits into
mainfrom
docs/prose-one-source
Nov 9, 2026
Merged

sergej-koscejev merged 2 commits into
mainfrom
docs/prose-one-source

Conversation

@sergej-koscejev

Copy link
Copy Markdown
Member

Summary

Each fact below now has one source. The other places keep what the reader acts on and point to the source.

Fact Source Now points to the source
--constraints modes mops edit model --help explain/edit.txt, examples/pages/editing.json.md, KDoc of ConstraintEnforcement, MpsWrite.modelEdit, ConceptValidityGuard
What a JSON edit batch does mops explain edit examples/pages/editing.json.md, skills/mops/SKILL.md
What project.command saves and reverts Project.command catalog entry (mops code help Project.command) examples/pages/editing.nodes.md, examples/pages/editing.md, skills/mops/SKILL.md, KDoc of CodeModeExtensions.command
Where the test system cache lives, when to delete it skills/mops-daemon/SKILL.md examples/pages/validation.md
When the daemon refreshes docs/daemon-request-concurrency.md docs/test-running-design.md

examples/pages/editing.md said Code Mode commands "do not roll back partial edits on an exception". CodeModeExtensions.command reloads every changed model on failure, so that line now points to mops code help Project.command too.

skills/mops/SKILL.md keeps "modules and models it created and module changes remain after a failure", because the Project.command entry does not say it yet.

Left as is:

Generated pages under docs/reference/ and skills/mops/references/ are regenerated.

Evidence

  • ./gradlew :cli:checkReference :cli:checkExamples :cli:test --tests '*ExamplesCommandTest' --tests '*CommandHelpTest': passes.
  • prek run --files <changed files>: passes.

Merge Danger

Blast Radius: docs

Open PRs that edit the same files and will need to merge main:

@sergej-koscejev
sergej-koscejev added this pull request to the merge queue Nov 9, 2026
Merged via the queue into main with commit 0af1c11 Nov 9, 2026
15 checks passed
@sergej-koscejev
sergej-koscejev deleted the docs/prose-one-source branch November 9, 2026 20:55
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