docs: document devai marker-based override model in agent docs#125
Merged
Conversation
…opment pages The override model (marker blocks, content-outside-is-yours, back-off when the markers are removed) was only documented on the devai package page. The user-facing ai-assisted-development docs still described the old behavior. - index.md: add an "Editing generated files" section describing the marker block, partial regeneration, and the full-ownership escape hatch - each agent page (claude-code, codex, cursor, gemini-cli, copilot, junie): replace the stale "written if not already present" / "left untouched" wording with the marker-aware behavior and link to the shared section - cursor.md: note the .mdc keeps YAML frontmatter as the first line with the marker block below it Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
github-actions
Bot
added
the
documentation
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
1 participant
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.
Summary
Follow-up to #124. That PR introduced the marker-based, user-overridable guideline files but only documented the override model on the
marko/devaipackage page — the user-facing AI-Assisted Development docs still described the old behavior.What changed
index.md— new "Editing generated files" section: the<!-- BEGIN/END marko:devai -->marker block, partial regeneration (only the marked region is rewritten), and the remove-the-markers full-ownership escape hatch.claude-code,codex,cursor,gemini-cli,copilot,junie) — replaced the now-stalewritten if not already present/if it already exists, it is left untouchedwording with the marker-aware behavior, each linking to the shared section.cursor.md— notes the.mdckeeps its YAML frontmatter as the first line, with the marker block below it.Testing
packages/docs-markdownsuite green: 17 passed. No stale wording remains (grepclean).Docs-only; no code changes.
🤖 Generated with Claude Code