Skip to content

feat: revive Oak Chain docs as canonical EDS surface#1

Draft
somarc wants to merge 9 commits into
mainfrom
feat-oak-docs-cleanup
Draft

feat: revive Oak Chain docs as canonical EDS surface#1
somarc wants to merge 9 commits into
mainfrom
feat-oak-docs-cleanup

Conversation

@somarc

@somarc somarc commented Jul 21, 2026

Copy link
Copy Markdown
Owner

Summary

Revives oak-chain-docs-eds as the canonical public Oak Chain documentation surface while preserving the existing visual identity.

This PR removes unsafe legacy authoring paths, makes DA the explicit authored-content/navigation authority, fixes shared accessibility and metadata issues, bounds code-embedded protocol language, adds release/test safeguards, and seeds the feature code bus with the static assets required by the reviewed pages.

Feature previews

Code changes

  • Removes repository scripts that called DA/AEM admin APIs directly, automatically promoted live content, or recursively wiped DA content.
  • Removes the retained template cleanup workflow and unused local Roboto assets.
  • Documents DA as the single source of truth and records implementation authority by owning repository.
  • Derives both primary navigation and docs-sidebar IA from the shared DA /nav.html fragment.
  • Removes stale tier/epoch/payment-verification language and emoji content from interactive graph definitions; adds regression guards.
  • Adds one valid 1200×630 default social image and removes duplicate static social-image tags.
  • Adds skip-link/main-landmark behavior, button-owned nav state, named menus, accessible table semantics, reduced-motion graph handling, and a corrected 404 shell.
  • Defers hero video loading and suppresses it for reduced-motion, Save-Data, and slow-connection users; the media remains DA-owned.
  • Pins Mermaid to 11.16.0 in strict mode and fixes CAD formatting.
  • Adds RELEASE-GATE.md, ten Node tests, CI test enforcement, Node engine policy, and safe dependency updates.
  • Adds query/sitemap configuration for the eventual reviewed release; generated live artifacts remain untouched.
  • Removes render-blocking third-party fonts, pre-reserves docs rails and authored visual blocks, adds intrinsic SVG dimensions, removes the hero poster from the LCP path, and makes scrollable code regions keyboard-focusable.
  • Seeds all tracked diagram assets and the favicon into the feature code bus. The reviewed architecture SVG and explainer links return 200.

DA content reviewed with this PR

DA remains the content source, so these edits are intentionally not Git fixtures. Thirteen DA documents were corrected and previewed only against this feature branch:

  • /nav.html
  • /index.html
  • /architecture.html
  • /guide/quickstart.html
  • /guide/smart-contract.html
  • /guide/testnet.html
  • /guide/economics.html
  • /operators/index.html
  • /how-it-works.html
  • /segment-gc.html
  • /guide/binaries.html
  • /guide/aem-integration.html
  • /faq.html
  • /thesis.html

The copy now distinguishes implemented, local/test evidence, deployment placeholders, experimental integration, and unavailable Mainnet behavior. It removes unsupported tier, validator-revenue, permissionless-network, permanence, GC-payment, binary-storage, AEM-readiness, throughput, and linear-scale claims.

Verification

  • npm test — 10/10 pass
  • npm run lint — JS and CSS pass
  • npm audit --audit-level=low — 0 vulnerabilities
  • git diff --check — pass
  • 13/13 da preview explain checks — no problematic class removal
  • Changed-page da audit full checks — 0 errors, 0 warnings on all routable pages
  • da site doctor --deep --agent — 29/29 routes, 16 block types, 0 missing assets, 0 section-shape violations
  • da audit contracts --verify-code — 16 block types, 0 missing assets
  • Runtime browser checks pass for homepage, navigation, sidebar, economics tables, Mermaid, operators copy, 404, social image, favicon, and all five tracked /diagrams/ assets
  • Refreshed AEM PSI check: pass — performance 100 on mobile and desktop for every checked page; home/economics/testnet/operators accessibility 100; local axe validation reports no current violations on architecture or AEM integration

/operators/index.html still hits the known da-cli nested-index audit bug (/operators/.plain.html instead of /operators/index.plain.html); its preview explanation and runtime checks pass.

Live-release gate

No content was published or deployed to *.aem.live. No live index/sitemap rebuild or orphan-route cleanup was run. Main live was independently verified unchanged.

RELEASE-GATE.md keeps live release closed until the Oak Chain x402 implementation described by the Oak Chain × x402 Decision Memo, Revision 3 (2026-07-18) is implemented and verified. Four existing live-only orphan routes and current sitemap leakage are documented but deliberately untouched until that gate opens and a human explicitly approves release.

@aem-code-sync

aem-code-sync Bot commented Jul 21, 2026

Copy link
Copy Markdown

Hello, I'm the AEM Code Sync Bot and I will run some actions to deploy your branch and validate page speed.
In case there are problems, just click a checkbox below to rerun the respective action.

  • Re-run all PSI checks
  • Re-run failed PSI checks
  • Re-sync branch
Commits

@aem-code-sync

aem-code-sync Bot commented Jul 21, 2026

Copy link
Copy Markdown
Page Scores Audits Google
📱 / PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
🖥️ / PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
📱 /architecture?assets=verified PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
🖥️ /architecture?assets=verified PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
📱 /guide/aem-integration PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
🖥️ /guide/aem-integration PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
📱 /guide/economics PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
🖥️ /guide/economics PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
📱 /guide/testnet PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
🖥️ /guide/testnet PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
📱 /operators/ PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI
🖥️ /operators/ PERFORMANCE A11Y SEO BEST PRACTICES SI FCP LCP TBT CLS PSI

@somarc
somarc marked this pull request as draft July 21, 2026 11:55
@somarc

somarc commented Jul 21, 2026

Copy link
Copy Markdown
Owner Author

Automated check status

  • build: pass
  • local tests/lint/audit: pass
  • aem-psi-check: fail on the current feature run
    • home mobile performance: 83
    • economics mobile performance: 84
    • architecture desktop CLS: 0.170
    • operators mobile Lighthouse returned a transient error
    • preview SEO scores are 66–69 on the intentionally non-indexable *.aem.page host

The PR remains draft under the x402 live-release gate. No merge or live-code rollout should occur until the gate criteria and final performance review are complete.

@aem-code-sync
aem-code-sync Bot temporarily deployed to feat-oak-docs-cleanup July 21, 2026 12:22 Inactive
@aem-code-sync
aem-code-sync Bot temporarily deployed to feat-oak-docs-cleanup July 21, 2026 12:34 Inactive
@somarc

somarc commented Jul 21, 2026

Copy link
Copy Markdown
Owner Author

PSI follow-up resolved

The failing Lighthouse gate has been addressed on the feature branch.

Final AEM PSI rerun: pass

  • Performance: 100 mobile and desktop for every checked page
  • Best Practices: 100 throughout
  • Accessibility: 100 on home, economics, testnet, and operators
  • Architecture/AEM integration: current local axe scan reports 0 violations; PSI reports 97/93 respectively
  • Preview SEO remains 66–69 because *.aem.page is intentionally non-indexable

Key fixes: removed render-blocking third-party fonts, preserved authored content as the eager docs section, moved the system map into the eager architecture section, removed the video poster from the LCP path, pre-reserved visual geometry, supplied intrinsic image dimensions, and made code regions keyboard-focusable.

The PR remains draft solely under the x402 live-release gate.

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