Skip to content

Trim customer docs to user-facing proof; relocate production docs to the wiki#16

Merged
SebaSOFT merged 2 commits into
mainfrom
growth/njs-growth-07-trim-customer-proof-docs
Jun 23, 2026
Merged

Trim customer docs to user-facing proof; relocate production docs to the wiki#16
SebaSOFT merged 2 commits into
mainfrom
growth/njs-growth-07-trim-customer-proof-docs

Conversation

@SebaSOFT

Copy link
Copy Markdown
Owner

Summary

The gh-pages site was publishing ~15 internal asset-production pages (image-gen prompts, storyboards, a visual design system, asset manifests, a playground capture spec, folder rules, asset metadata) inside the customer-facing "Proof Assets" nav. These are developer/operator-oriented, were the origin of the private chaos-vault citations, and made the earlier proof PRs brittle (most failing tests policed internal docs). This PR makes the customer site serve only user-relevant proof.

Customer-facing "Benchmarks & Proof" (now lean)

  • docs/benchmarks/index.md — tight proof landing: intro + explainability diagram + links.
  • docs/benchmarks/methodology.md — user-readable: competitor/scenario/input-size matrices, how each metric is measured, a result-field dictionary, and the no-fabrication policy (embeds the methodology card).
  • docs/benchmarks/results.md — measured charts + table (unchanged; generated).
  • docs/benchmarks/ai-rule-safety.mdnew explainer embedding the 5 carousel slides, reframed as "why AI-drafted rules need validation".
  • Nav trimmed to Overview / Benchmark Results / Methodology / AI-Rule Safety. All generated SVGs kept.

Relocated out of the repo

The internal production docs were moved into the private chaos-vault wiki (50-research/neuron-js-proof-assets/) and removed here: prompt-kit, visual-proof-system, benchmark-visual-pack, asset prompts/*, storyboard/*, asset-manifest, folder READMEs, the assets/generated/*.md metadata, and the playground capture spec (+ empty docs/playground/). (That wiki commit is local on the owner's machine; not part of this PR.)

Tests

  • Deleted playground-capture-contract.test.ts (it policed the moved playground spec/storyboard/nav entry).
  • Added customer-docs-surface.test.ts: asserts the customer pages + generated SVGs exist, the internal pages are absent, and customer pages contain no chaos-vault references.
  • benchmark-contract.test.ts / benchmark-results.test.ts unchanged and passing.

Validation

  • yarn lint ✅ (50 files) · yarn test ✅ (13 files / 68) · yarn examples ✅ · yarn build ✅ · yarn docs:build
  • dist has no chaos-vault strings, and no internal pages built (visual-proof-system, prompt-kit, benchmark-visual-pack, playground/ all absent); the 4 customer pages build and the chart/diagram/carousel SVGs ship.

Why this also fixes the recurring issues

  1. Private-research leak — the pages that cited chaos-vault are gone from the published surface, removing the whole class of leak (not just scrubbed strings).
  2. SVGs not shown — the images that matter now have clear customer placement (results, diagram on the landing, carousel on the AI-rule-safety page).
  3. Brittle PRs — tests no longer police internal process docs; the surface guard prevents regressions.

🤖 Generated with Claude Code

The gh-pages site was publishing ~15 internal asset-production pages (image-gen
prompts, storyboards, a visual design system, asset manifests, a playground
capture spec, folder rules, asset metadata) in the customer nav. These are
developer/operator-oriented, were the source of the private chaos-vault
citations, and made the proof PRs brittle (most tests policed internal docs).

Customer-facing "Benchmarks & Proof" is now lean:
- index.md: tight proof landing (intro + explainability diagram + links).
- methodology.md: user-readable (competitor/scenario/size matrices, how each
  metric is measured, result-field dictionary, no-fabrication policy).
- results.md: measured charts + table (unchanged, generated).
- ai-rule-safety.md: NEW explainer embedding the 5 carousel slides reframed as
  "why AI-drafted rules need validation".
- All generated SVGs kept; nav trimmed to Overview/Results/Methodology/AI-Rule Safety.

Internal production docs were relocated to the private chaos-vault wiki
(50-research/neuron-js-proof-assets/) and removed from this repo.

Tests: delete playground-capture-contract.test.ts (policed moved files); add
customer-docs-surface.test.ts asserting the lean surface (customer pages + SVGs
present, internal pages absent, no chaos-vault refs).

Verified: lint, test (13 files/68), examples, build, docs:build; dist has no
chaos-vault strings and no internal pages built.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request cleans up the public documentation by removing internal asset-production files, prompts, and storyboards, while introducing a new AI-rule safety page and updating the benchmark index and methodology. It also adds a contract test to ensure only customer-relevant pages and assets are published. The feedback suggests expanding the test's SVG asset list to include all newly referenced diagrams and carousel images, ensuring complete coverage of the customer-facing documentation surface.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread tests/contracts/customer-docs-surface.test.ts
Expand customerChartSvgs to every generated SVG referenced by the customer
docs (5 benchmark charts, explainability diagram, methodology card, 5 carousel
slides) per PR #16 review, instead of a representative subset.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@SebaSOFT SebaSOFT merged commit e3bd19f into main Jun 23, 2026
2 checks passed
@SebaSOFT SebaSOFT deleted the growth/njs-growth-07-trim-customer-proof-docs branch June 23, 2026 23:01
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.

2 participants