Skip to content

docs(mdbook): avoid stale placeholder warning translations#8194

Draft
Audacity88 wants to merge 1 commit into
zeroclaw-labs:masterfrom
EyrieCommander:codex/issue-7269-mdbook-placeholders
Draft

docs(mdbook): avoid stale placeholder warning translations#8194
Audacity88 wants to merge 1 commit into
zeroclaw-labs:masterfrom
EyrieCommander:codex/issue-7269-mdbook-placeholders

Conversation

@Audacity88

@Audacity88 Audacity88 commented Jun 22, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Base branch: master
  • What changed and why:
    • Replaced fragile fenced placeholder examples in delegation docs with inline-code examples.
    • Replaced the fenced Nextcloud Talk placeholder URL with an inline-code URL.
    • This avoids matching stale .po translations that dropped code fences and exposed <target>, <caller>, and URL placeholders as raw HTML.
  • Scope boundary: Source docs only. No .po catalog edits, generated reference changes, runtime changes, or translation-tool changes.
  • Blast radius: Docs rendering for two English source pages and translated fallback behavior for changed strings.
  • Linked issue(s): Related bug(docs): clean up docs build warning noise #7269
  • Labels: docs, risk: low, size: S

Validation Evidence (required)

  • Commands run and tail output:
git diff --check origin/master...HEAD

No output; passed.

node - <<'NODE'
const fs = require('fs');
const checks = [
  ['docs/book/src/channels/nextcloud-talk.md', '```\\nhttps://<your-public-url>/nextcloud-talk/<alias>\\n```'],
  ['docs/book/src/agents/delegation.md', '```text\\ndelegation is forbidden by the caller'],
  ['docs/book/src/agents/delegation.md', '```text\\ndelegate target "<target>" is not reachable'],
  ['docs/book/src/agents/delegation.md', '```text\\ndelegate target "<target>" (risk profile'],
];
let failed = false;
for (const [file, needle] of checks) {
  const text = fs.readFileSync(file, 'utf8');
  if (text.includes(needle)) {
    console.error(`still present: ${file}: ${needle.slice(0,80)}`);
    failed = true;
  }
}
if (failed) process.exit(1);
console.log('stale fenced placeholder msgids absent from English source');
NODE

Output:

stale fenced placeholder msgids absent from English source
env DOCS_FILES='docs/book/src/agents/delegation.md
docs/book/src/channels/nextcloud-talk.md' bash scripts/ci/docs_links_gate.sh

Output:

Collected 0 added link(s) from 2 docs file(s).
No added links detected in changed docs lines.
env DOCS_FILES='docs/book/src/agents/delegation.md
docs/book/src/channels/nextcloud-talk.md' bash scripts/ci/docs_quality_gate.sh

Tail output:

No prose em-dashes in changed docs files.
Linting docs files: docs/book/src/agents/delegation.md docs/book/src/channels/nextcloud-talk.md
markdownlint-cli2 v0.20.0 (markdownlint v0.40.0)
Finding: docs/book/src/agents/delegation.md docs/book/src/channels/nextcloud-talk.md !target/** !docs/book/src/SUMMARY.md
Linting: 2 file(s)
Summary: 0 error(s)
  • Beyond CI — what did you manually verify? Checked the broken stale gettext shapes in the existing .po catalogs, confirmed the matching fenced English msgids are gone from source, and reviewed the changed docs for clarity and consistency.
  • If any command was intentionally skipped, why: Full cargo mdbook build was not run; this is a docs-source-only slice, and mdBook/Cargo builds are a broader rendered-warning validation boundary.

Security & Privacy Impact (required)

  • New permissions, capabilities, or file system access scope? No
  • New external network calls? No
  • Secrets / tokens / credentials handling changed? No
  • PII, real identities, or personal data in diff, tests, fixtures, or docs? No
  • If any Yes, describe the risk and mitigation: N/A

Compatibility (required)

  • Backward compatible? Yes
  • Config / env / CLI surface changed? No
  • If No or Yes to either: N/A

Rollback (required for risk: medium and risk: high)

Low-risk PR: git revert <sha>.

@Audacity88 Audacity88 added size: S Auto size: 81-250 non-doc changed lines. risk: low Auto risk: docs/chore-only paths. docs Auto scope: docs/markdown/template files changed. labels Jun 22, 2026
@Audacity88 Audacity88 force-pushed the codex/issue-7269-mdbook-placeholders branch from 45e9aeb to 6ace673 Compare June 22, 2026 22:29
@singlerider

Copy link
Copy Markdown
Collaborator

Draft, docs-only, direction only, no verdict. I read both files.

Direction notes:

  1. The conversion is sound where the content is a single short token: the nextcloud-talk webhook URL reads fine as an inline span, and the first delegation refusal is borderline but acceptable inline.

  2. The two long delegation refusal strings (the reachability one and the escalation one) are full sentences with embedded placeholders. As inline code spans they will render as one unbroken monospace run that does not soft-wrap cleanly in a narrow mdbook column, where a fenced block would have wrapped or scrolled. If the only goal is to stop the translation-staleness linter from treating these as translatable placeholder blocks, confirm that an inline span actually exempts them; if the linter keys on backtick content generally, you may have just moved the problem. Worth verifying the warning is actually gone on the rendered output before flipping out of draft.

  3. If the linter is specifically flagging fenced blocks with no language tag, the alternative is to tag them (```text is already there on two of them) rather than collapse to inline. That keeps the block presentation for the long strings. Either direction is fine, but pick based on what the linter actually keys on rather than guessing.

Confirm the warning is gone post-render, then this is a clean docs change. Flag me when it is ready for a verdict.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Auto scope: docs/markdown/template files changed. risk: low Auto risk: docs/chore-only paths. size: S Auto size: 81-250 non-doc changed lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants