WorkRoot/WRNexusJSDoc
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: audit release access and portal architecture

Browse Source
This commit is contained in:
Clintchiz
2026-07-12 23:23:29 +05:30
parent 5eea460479
commit 7a049d15fa
9 changed files with 84 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/audits/2026-07-12-baseline.md
+3
View File
@@ -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.
docs/documentation-coverage-matrix.md
+29
View File
@@ -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 |
docs/documentation-information-architecture.md
+3
View File
@@ -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.
docs/post-deploy-checklist.md
+8
View File
@@ -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/.
docs/redirect-map.md
+3
View File
@@ -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.
docs/release-access-status.md
+7
View File
@@ -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.
docs/release-checklist.md
+9
View File
@@ -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.
docs/seo-metadata-matrix.md
+3
View File
@@ -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.
docs/site-audit.md
+19
View File
@@ -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/.