Skip to content

docs: restructure protocol documentation - #164

Open
kristoferlund wants to merge 7 commits into
mainfrom
docs/restructure-information-architecture
Open

kristoferlund wants to merge 7 commits into
mainfrom
docs/restructure-information-architecture

Conversation

@kristoferlund

@kristoferlund kristoferlund commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Summary

  • reorganize the site into Guide, Client Integration, Reference, and Changes
  • make the root page a dedicated docs landing page with four icon-led section introductions and curated deep links, without a sidebar or article tools
  • rename Change History to Changes at /changes, with permanent redirects for the previous page and raw Markdown URLs
  • establish canonical protocol release history for 1.0–1.4, reconstructed from published Lexicon releases with source dates and compatibility notes
  • present Hypercerts Protocol alongside the seven components with a version badge and one-sentence card description; keep the detailed current-release summary on Changes and source links in the protocol's release entries
  • keep overview pages focused on current capabilities and versions, and record the current-state editorial rule for documentation and code comments
  • import CGS, relay, and feed changelogs; fetch published release versions at build time and include them in the existing refresh fingerprint; provide explicit API, SDK, and entryway development placeholders
  • reuse validated snapshots on local dev startup and use existing GitHub CLI credentials for fresh local fetches, avoiding unauthenticated rate limits
  • give each section its own sidebar and keep previous/next navigation within that section
  • rewrite the welcome page and Guide around the landing-page journey: shared knowledge, connected contributions, trust over time, funding, and building
  • introduce technical concepts through plain-language explanations and short examples; add dedicated project, evidence/measurement, and evaluation chapters
  • align protocol and Lexicon guidance with the released @hypercerts-org/lexicon v1.4.0 schemas
  • remove unsupported quickstart, evaluation workflow, Scaffold, and Hyperboards documentation while preserving legacy redirects
  • clarify trust, validation, record lifecycle, funding-receipt, identity, and indexing boundaries
  • add a complete Hypercerts and Certified schema inventory and document the source-ownership model

Validation

  • npm test (50 tests pass, including development caching, credential precedence, release metadata failures, placeholder states, fingerprint changes, shared Markdown expansion, and imported changelog anchors)
  • npm run build (63 documentation pages generated)
  • rendered local-link validation across all 63 pages
  • navigation, search entries, exported pages, and all 14 Guide chapter transitions checked
  • browser checks of the static export, including the relationship diagram, mobile content, and the Guide-to-Client-Integration handoff
  • landing-page checks in light/dark modes and at desktop, tablet, and 320px mobile widths; verified entry into section sidebars and return to the sidebar-free landing page
  • verified the protocol and seven component badges, protocol history 1.0–1.4, raw exports, search grouping, and mobile protocol-history navigation
  • confirmed dev generation reuses snapshots with zero GitHub requests; local / and /changes return HTTP 200 with release content; fresh authenticated production build succeeds
  • git diff --check

Known warning

  • Next.js reports the existing /reference/releases page-data warning at 241 kB because it renders the imported upstream changelog.

Release alignment

Badges show actual published versions: Lexicons 1.4.0, CGS 0.6.0, and Feed Service 0.1.1. The other four components are marked under development. The relay has an imported changelog but no published release. Establishing API/entryway release sources, publishing the new SDK, and aligning component major/minor numbers remain work in the owning projects; these docs do not invent releases or substitute versions from legacy products.

@vercel

vercel Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
hypercerts-v0.2-documentation Ready Ready Preview Sep 16, 2026 10:17am UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 15, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 048bcc08-7437-4397-b52c-7519477c2373


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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