[JUM-895][Docs] Keep maintainer provenance off the developer site and pair every contributor doc - #538
Merged
Conversation
…pair every contributor doc JUM-895. The website sync now strips provenance-only parentheticals and Linear link definitions (stripMaintainerProvenance); the six Service Management E1-E8 maintainer design records leave the published tree and their old URLs resolve to the Service Manager guide; the remaining inline citations in the guide, designer-core and dead-letter-queue READMEs, Domain Designer features and runtime contracts moved into parentheses or were reworded. The designer-core README no longer claims npm publishing is manual, and the Portuguese runtime contracts page no longer lists four editable keys where nine exist. Six English-only evidence records under documentation/md gain Portuguese twins, and check-current-governance-docs now fails on a missing language twin. The 40 JUM-895 allow-list entries are gone. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_a6b0e579-3d12-4b54-b5c0-13b71c145f46) |
…cs-audience-audit # Conflicts: # test-map.json
…cs-audience-audit
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_8132ab59-f285-43de-bc73-aec5a45583a0) |
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.
Summary
Keeps maintainer provenance off the developer site and pairs every contributor document with its translation. The website sync strips provenance-only parentheticals and Linear link definitions; six maintainer design records leave the published tree (old URLs resolve to the Service Manager guide); remaining inline citations in published sources are reworded; six English-only records gain Portuguese twins and a governance check now enforces the pair. The 40 JUM-895 allow-list entries are gone.
Problem Statement
With JUM-892's gate and an empty allow-list, the published
/docstree had 589 findings across 42 file/rule pairs (issue ids, requirement numbers, a.agents/path) — contributor docs fromdocumentation/md/**republished verbatim, against Requirement 093 rule 4. Audit also found:git ls-files documentation/md→ 138 English vs 132 Portuguese files (six missing twins, Requirement 076, unchecked);packages/designer-core/READMEstating 'no automatic publish exists' (false since JUM-894);RUNTIME-ENVIRONMENT-CONTRACTS.pt-BR.mdlisting four editable keys where Requirement 126 and the English page list nine.Project Tracking (Required)
Jumentix(https://linear.app/jumentix)Start date->End date): 2026-09-26 -> 2026-10-17P0/P1/P2): P2Branch Promotion Path (Required)
[JUM-XXXX][Nature] <concise outcome>JUM-XXXXmatches the single Linear Issue declared above.dev.main, it is a release promotion sourced fromdev, references the task PRs/issues already merged intodev, and introduces no unreviewed changes.main.Bidirectional Traceability (Required)
JUM-895: 34c2cfcScope of Change
Domain / Business Rules
Application / Use Cases
Adapters / Infrastructure
apps/jumentix-website/scripts/content-leaks.mjs:stripMaintainerProvenance(+content-leaks.test.mjs, 4 tests); applied insync-markdown-content.mjs.apps/jumentix-website/config/content-sources.json: sixservice-management-*E1–E8 records removed;app/docs/[[...mdxPath]]/page.tsxresolves their old URLs toguides/service-management.ci-cd/check-current-governance-docs.js:missingLanguageTwins(+ci-cd/test/check-current-governance-docs.test.ts).ci-cd/documentation-audience-allowlist.json: 46 → 2 (only JUM-899'spackage-scripts).API / Contracts (OpenAPI, DTOs, handlers, controllers)
Detailed Technical Changes
Architecture and Design Alignment
Security Impact
Data and Migration Impact
Breaking Changes
None.
Acceptance Criteria
Test Plan (Evidence)
bun run docs:check-audience— passedbun run docs:check-current-governance— passed; without the new twins staged it listed exactly the six filesbun run website:check-content-routes— 0 declared unreachablecontent-smoke— Documentation content smoke passed with 92 English and 92 Portuguese pages.bun run test:unit— task gate: Tests: 1161 passed, 1161 total; @jumentix/website test:unit: Tests: 293 passed, 293 totalExtra evidence:
Feedback Resolution (Required)
resolved, a SHA from this PR.Coverage
SonarQube Cloud
Performance / Reliability Impact
No measurable impact.
Observability
Deployment and Rollout
dev, promote with the next release.Risks and Mitigations
Documentation Updates
mainmergeReviewer Checklist
🤖 Generated with Claude Code
Note
Low Risk
Documentation, content routing, and nav changes only; no application runtime, auth, or data-path changes.
Overview
Removes six maintainer-only Service Management reference pages from the published docs tree and redirects their old
/reference/service-management-*URLs to the developer-facing Service Manager guide viaretiredReferenceTargetin the docs router and matching removals fromcontent-sources.jsonand reference nav.Audience cleanup on what stays public: Linear/issue/requirement citations and links into the retired E-chain are stripped or reworded across the Service Manager guide, Domain Designer reference, frontend offline layer,
designer-core, and architecture/SPA guides; the guide now documents Architecture and OpenAPI tabs and drops deep links to unpublished topics.Adds full site docs for
@jumentix/dead-letter-queue(package nav EN/PT) and refreshes the generated rootpackage-scriptsreference (CI gate, docker, dead-letter smoke, website deps, etc.). Updatesdesigner-corepublish wording to reflect automated npm publish after release.Reviewed by Cursor Bugbot for commit 2228479. Bugbot is set up for automated code reviews on this repo. Configure here.