From 7a049d15fa9ebeb433d95b91c8cc5850336a51e7 Mon Sep 17 00:00:00 2001 From: Ajay Ghanwat Date: Sun, 12 Jul 2026 23:23:29 +0530 Subject: [PATCH] docs: audit release access and portal architecture --- docs/audits/2026-07-12-baseline.md | 3 ++ docs/documentation-coverage-matrix.md | 29 +++++++++++++++++++ .../documentation-information-architecture.md | 3 ++ docs/post-deploy-checklist.md | 8 +++++ docs/redirect-map.md | 3 ++ docs/release-access-status.md | 7 +++++ docs/release-checklist.md | 9 ++++++ docs/seo-metadata-matrix.md | 3 ++ docs/site-audit.md | 19 ++++++++++++ 9 files changed, 84 insertions(+) create mode 100644 docs/audits/2026-07-12-baseline.md create mode 100644 docs/documentation-coverage-matrix.md create mode 100644 docs/documentation-information-architecture.md create mode 100644 docs/post-deploy-checklist.md create mode 100644 docs/redirect-map.md create mode 100644 docs/release-access-status.md create mode 100644 docs/release-checklist.md create mode 100644 docs/seo-metadata-matrix.md create mode 100644 docs/site-audit.md diff --git a/docs/audits/2026-07-12-baseline.md b/docs/audits/2026-07-12-baseline.md new file mode 100644 index 00000000..1141caa0 --- /dev/null +++ b/docs/audits/2026-07-12-baseline.md @@ -0,0 +1,3 @@ +# Baseline audit + +Automated Bun install/docs/test/check/build passed before implementation. Lighthouse, browser accessibility, and screenshots were unavailable; no scores are claimed. diff --git a/docs/documentation-coverage-matrix.md b/docs/documentation-coverage-matrix.md new file mode 100644 index 00000000..0c604411 --- /dev/null +++ b/docs/documentation-coverage-matrix.md @@ -0,0 +1,29 @@ +# Documentation coverage matrix + +| Area | Package reference | Concept guide | Runnable fixture | Tests | Stability | Limitation | +|---|---|---|---|---|---|---| +| @wrnexus/ai | /packages/ai | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/authz | /packages/authz | /guides/authorization | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/cli | /packages/cli | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/compiler | /packages/compiler | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/core | /packages/core | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/csr | /packages/csr | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/db | /packages/db | /guides/db | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/dev-server | /packages/dev-server | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/encryption | /packages/encryption | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/i18n | /packages/i18n | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/jwt | /packages/jwt | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/mobile | /packages/mobile | /guides/mobile | Planned | Generator coverage | Experimental | No standalone CI fixture | +| @wrnexus/native | /packages/native | Architecture/package guide | Planned | Generator coverage | Experimental | No standalone CI fixture | +| @wrnexus/oauth | /packages/oauth | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/pubsub | /packages/pubsub | /guides/pubsub | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/queue | /packages/queue | /guides/queues | Planned | Generator coverage | Experimental | No standalone CI fixture | +| @wrnexus/reactive | /packages/reactive | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/router | /packages/router | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/ssr | /packages/ssr | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/styles | /packages/styles | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/test | /packages/test | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/tracking | /packages/tracking | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/ui | /packages/ui | Architecture/package guide | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/uploader | /packages/uploader | /guides/uploads | Planned | Generator coverage | Preview | No standalone CI fixture | +| @wrnexus/validation | /packages/validation | /guides/forms-and-validation | Planned | Generator coverage | Preview | No standalone CI fixture | diff --git a/docs/documentation-information-architecture.md b/docs/documentation-information-architecture.md new file mode 100644 index 00000000..1bfcae67 --- /dev/null +++ b/docs/documentation-information-architecture.md @@ -0,0 +1,3 @@ +# Documentation information architecture + +Global navigation groups Learn, Reference, Guides, Project, and Trust. Canonical discovery begins at the homepage, then /getting-started and /tutorial. Exact APIs live under /packages. Conceptual tasks live under /guides. Status and trust live at /roadmap, /changelog, /security, /support, /license, and /access. Machine discovery uses robots.txt, sitemap.xml, llms.txt, llms-full.txt, and docs-index.json. diff --git a/docs/post-deploy-checklist.md b/docs/post-deploy-checklist.md new file mode 100644 index 00000000..840366c7 --- /dev/null +++ b/docs/post-deploy-checklist.md @@ -0,0 +1,8 @@ +# Post-deploy checklist + +1. Fetch representative HTML, robots.txt, sitemap.xml, llms.txt, llms-full.txt, and docs-index.json. +2. Run Lighthouse mobile under controlled conditions; target performance/accessibility/SEO/best-practices >=95 with no critical accessibility issue. +3. Run keyboard, screen reader, zoom, reduced-motion, link, anchor, and responsive overflow checks. +4. Submit sitemap in Google Search Console and Bing Webmaster Tools after domain ownership is verified. +5. Inspect canonical selection, rich-result eligibility, crawl errors, CSP reports, server logs, and 404s. +6. Save dated reports under docs/audits/. diff --git a/docs/redirect-map.md b/docs/redirect-map.md new file mode 100644 index 00000000..46a29b99 --- /dev/null +++ b/docs/redirect-map.md @@ -0,0 +1,3 @@ +# Redirect map + +No legacy redirects are currently required: existing /, /getting-started, /architecture, /language, /packages, and /packages/:name remain canonical. If versioned archives are introduced, current unversioned docs should canonicalize to the active release and archived URLs must remain immutable. diff --git a/docs/release-access-status.md b/docs/release-access-status.md new file mode 100644 index 00000000..3c551d93 --- /dev/null +++ b/docs/release-access-status.md @@ -0,0 +1,7 @@ +# Release and access status + +## Decision: Mode B — Private Developer Preview + +Active version: 0.2.15, derived from package.json#wrnexus.version. All 25 installed @wrnexus packages resolve to 0.2.15. On 2026-07-12, npm view using a clean empty user config returned E404 for @wrnexus/cli@0.2.15 and @wrnexus/core@0.2.15. The repository remote is a private WorkRoot Git service and no public license file exists. + +External users cannot execute an installation without approved private registry credentials. The truthful CTA is Request preview access. After approval, the canonical command is bunx @wrnexus/cli@0.2.15 create my-app. Tokens must never appear in documentation or source. diff --git a/docs/release-checklist.md b/docs/release-checklist.md new file mode 100644 index 00000000..93375964 --- /dev/null +++ b/docs/release-checklist.md @@ -0,0 +1,9 @@ +# Release checklist + +- [ ] Confirm all @wrnexus versions align with package.json#wrnexus.version. +- [ ] Run bun install, docs:generate twice, test, check, build, and production smoke. +- [ ] Verify clean-registry access status and CTA. +- [ ] Crawl routes, links, anchors, canonical metadata, sitemap, robots, and AI files. +- [ ] Run mobile/desktop accessibility and Lighthouse audits. +- [ ] Confirm license, disclosure contact, support policy, changelog, and showcase approvals. +- [ ] Verify no tokens, private paths, fake community links, or unsupported claims. diff --git a/docs/seo-metadata-matrix.md b/docs/seo-metadata-matrix.md new file mode 100644 index 00000000..0bb33a76 --- /dev/null +++ b/docs/seo-metadata-matrix.md @@ -0,0 +1,3 @@ +# SEO metadata matrix + +Every canonical portal page defines a unique descriptive title, description, and absolute canonical. Package metadata is generated from installed package metadata. Sitemap and robots cover portal, guides, release, and package routes. Structured-data support is not exposed by the installed .wrn SEO grammar and remains a framework/generator gap. Preview routes remain indexable because the documentation is public; private package/source locations are not linked. diff --git a/docs/site-audit.md b/docs/site-audit.md new file mode 100644 index 00000000..204c48a1 --- /dev/null +++ b/docs/site-audit.md @@ -0,0 +1,19 @@ +# WRNexusJS site audit + +Date: 2026-07-12. Baseline: Bun 1.3.14, framework 0.2.15. + +## Baseline results + +- bun install: pass (169 installs / 209 packages, unchanged). +- docs generation: pass (25 package pages and 5 prior site pages). +- tests: 6 pass. Check: pass. Production build: pass, 30 routes. +- Access test with an empty npm config: @wrnexus/cli and @wrnexus/core returned npm E404. +- Repository: private WorkRoot Git remote; no public LICENSE, SECURITY, or CHANGELOG file found. + +## Findings + +The prior generator duplicated package H1s, descriptions, install blocks, and dumped full declarations. It also rewrote hand-authored core pages, used four desktop-only nav links, hid navigation on mobile, branded inconsistently, and presented an unusable public create command. Metadata lacked explicit canonicals and route coverage. No sitemap, robots file, docs index, release/access route, security/support/license policy, showcase evidence notes, benchmarks methodology page, or 404 source existed. + +## Audit limitations + +Browser tooling, Lighthouse, axe, screenshots, and an authenticated clean scaffold were unavailable. Scores are therefore not fabricated; post-deploy measurements remain required under docs/audits/.