Skip to content

[JUM-895][Docs] Keep maintainer provenance off the developer site and pair every contributor doc - #538

Merged
web2solutions merged 3 commits into
devfrom
claude/docs/JUM-895-docs-audience-audit
Sep 26, 2026
Merged

web2solutions merged 3 commits into
devfrom
claude/docs/JUM-895-docs-audience-audit

Conversation

@web2solutions

@web2solutions web2solutions commented Sep 26, 2026 •

Copy link
Copy Markdown
Owner

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 /docs tree had 589 findings across 42 file/rule pairs (issue ids, requirement numbers, a .agents/ path) — contributor docs from documentation/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/README stating 'no automatic publish exists' (false since JUM-894); RUNTIME-ENVIRONMENT-CONTRACTS.pt-BR.md listing four editable keys where Requirement 126 and the English page list nine.

  • Related issue(s): JUM-895
  • Related PR(s): none
  • Related check run(s): none yet

Project Tracking (Required)

Branch Promotion Path (Required)

  • Source branch: claude/docs/JUM-895-docs-audience-audit
  • Target branch: dev
  • Required PR title format: [JUM-XXXX][Nature] <concise outcome>
  • The leading JUM-XXXX matches the single Linear Issue declared above.
  • This task PR targets dev.
  • If this PR targets main, it is a release promotion sourced from dev, references the task PRs/issues already merged into dev, and introduces no unreviewed changes.
  • This PR is not a direct task/topic branch promotion to main.

Bidirectional Traceability (Required)

  • Every linked issue already contains this PR URL.
  • Every linked issue already contains commit hash/range evidence.
  • PR description includes mapping of task -> commit(s).
  • Task -> commit(s) mapping:

Scope of Change

Domain / Business Rules

  • None.

Application / Use Cases

  • None.

Adapters / Infrastructure

  • apps/jumentix-website/scripts/content-leaks.mjs: stripMaintainerProvenance (+ content-leaks.test.mjs, 4 tests); applied in sync-markdown-content.mjs.
  • apps/jumentix-website/config/content-sources.json: six service-management-* E1–E8 records removed; app/docs/[[...mdxPath]]/page.tsx resolves their old URLs to guides/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's package-scripts).

API / Contracts (OpenAPI, DTOs, handlers, controllers)

  • None.

Detailed Technical Changes

  1. Measured: 881 provenance hits in published MDX → 385 after the filter → 0 (outside package-scripts) after unpublishing the E-chain and rewording 12 source files (EN+PT).
  2. Sources reworded: the Service Manager guide, designer-core and dead-letter-queue READMEs, Domain Designer features, runtime env contracts.
  3. New PT twins: BUN-BRANCH-COVERAGE-SPIKE, BUN-INSTALL-COMPATIBILITY-AUDIT, BUN-TAXONOMY-BASELINE-VALIDATION, EPIC-RELEASE-TAG-DRIVEN-CLOSURE (status also updated to measured reality), PLATFORM-DEPENDENT-SUITES, TEST-PYRAMID-ROLLOUT-REPORT.
  4. Contributor convention documented (CONTRIBUTING-AND-TOOLING, DOCUMENTATION-EXPERIENCE, EN+PT): provenance in parentheses.
  5. Regeneration also refreshed pages whose committed output had drifted from their sources.

Architecture and Design Alignment

  • Domain logic remains inside domain/application layers.
  • Controllers/handlers do not instantiate repositories/services directly.
  • Ports/adapters boundaries are respected.
  • No new circular dependencies introduced.
  • Event publishing/listening flow remains consistent.

Security Impact

  • Security impact: No security impact.
  • Secrets handling reviewed: [ ] Yes [ ] No [x] N/A
  • Input/output sanitization reviewed: [ ] Yes [ ] No [x] N/A
  • AuthN/AuthZ impact: [ ] Yes [x] No
  • Data exposure risk (password/salt/token/PII): [ ] Yes [x] No
  • Sonar security findings addressed or unaffected: [x] Yes [ ] No

Data and Migration Impact

  • Data model impact: none.
  • Migration required: [ ] Yes [x] No
  • Rollback strategy: revert the PR.

Breaking Changes

None.

Acceptance Criteria

  • Feature/bug behavior matches expected functional outcome.
  • Error paths and edge cases are covered.
  • API contract changes (if any) are documented and validated.
  • Architecture boundaries remain enforced.
  • No regression in existing workflows.

Test Plan (Evidence)

  • bun run docs:check-audience — passed
  • bun run docs:check-current-governance — passed; without the new twins staged it listed exactly the six files
  • bun run website:check-content-routes — 0 declared unreachable
  • content-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 total

Extra evidence:

# gate with an empty allow-list, before → after
589 violations → 30 (all package-scripts, owned by JUM-899)

Feedback Resolution (Required)

  • Every GitHub review thread is resolved natively.
  • Every general comment has a visible resolution response by the PR author or a repository maintainer.
  • Each resolution response uses exactly one marker and, for resolved, a SHA from this PR.

Coverage

  • Project coverage >= 95%: [x] Yes [ ] No
  • Patch coverage >= 95%: [x] Yes [ ] No
  • Codecov status passing: [ ] Yes [ ] No (pending CI)

SonarQube Cloud

  • Quality Gate passing: [ ] Yes [ ] No (pending CI)
  • New vulnerabilities introduced: [ ] Yes [x] No
  • New security hotspots reviewed: [ ] Yes [ ] No [x] N/A

Performance / Reliability Impact

No measurable impact.

Observability

  • Logs updated: [ ] Yes [x] No
  • Metrics/Tracing updated: [ ] Yes [ ] No [x] N/A

Deployment and Rollout

  • Deployment notes: none.
  • Feature flag needed: [ ] Yes [x] No
  • Rollout strategy: merge to dev, promote with the next release.
  • Rollback steps: revert the PR.

Risks and Mitigations

  1. Risk: none material.\n Mitigation: n/a.

Documentation Updates

  • README updated (if needed)
  • Additional docs updated (if needed)
  • Changelog untouched; GitHub Actions synchronizes it only after the validated main merge

Reviewer Checklist

  • Changes are clear and scoped.
  • Acceptance criteria are testable and satisfied.
  • Tests are sufficient for risk level.
  • Security and data impacts are addressed.
  • CI checks pass fully.

🤖 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 via retiredReferenceTarget in the docs router and matching removals from content-sources.json and 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 root package-scripts reference (CI gate, docker, dead-letter smoke, website deps, etc.). Updates designer-core publish 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.

…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>
@cursor

cursor Bot commented Sep 26, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot 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)

@cursor

cursor Bot commented Sep 26, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot 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)

@web2solutions
web2solutions merged commit 96f5330 into dev Sep 26, 2026
36 of 37 checks passed
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