docs: restructure protocol documentation - #164
Open
kristoferlund wants to merge 19 commits into
Open
kristoferlund wants to merge 19 commits into
kristoferlund wants to merge 19 commits into
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID:
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. Comment |
Pin pnpm@12.6.0 through packageManager, import the lockfile from package-lock.json with unchanged resolved versions, and move the baseline-browser-mapping override to pnpm-workspace.yaml. CI and Vercel install with --frozen-lockfile.
Record that all pages are written in this repository and only component changelogs are imported. Retire the ePDS and legacy Hyperindex pages in the migration map and update maintainer docs to pnpm commands.
ePDS is being sunset in favour of Entryway and Hyperindex is no longer maintained. Remove the imported pages, their navigation entries and source registrations, and redirect the old routes and raw Markdown URLs to the canonical documents in their own repositories. Inbound links now point to the same GitHub documents.
Open the docs landing page and Start Here with the hypercerts.org framing: an open protocol connecting projects with those who review, vouch for, and back them. Introduce trust signals, data ownership and portability, the case for a shared language, and Certified as the identity service. Add draft Mermaid diagrams for account-owned records and for trust building over time.
Replace the draft Mermaid chain with a theme-aware SVG step chart based on the hypercerts.org trust timeline, plus responsive cards naming each signal's publisher and record type with links to the Guide pages.
Keep the case for harmonized data without naming an initiative the Foundation has no official partnership with.
Add theme-aware SVG diagrams for account-owned records and portability on Why AT Protocol? and for the records around one activity on A Shared Language. Explain that records are spread across servers as well as accounts, and add links to PDSls and AT Protocol explainers.
Render schema tables at build time from the pinned @hypercerts-org/lexicon package (1.4.1) through lexicon-schema markers, shared by page rendering, search, and raw Markdown. Move Hypercerts and Certified Lexicons up one navigation level and document every record type with an overview, usage, a validated example, usage conventions, and related links. Update the inventory, index pages, and introduction for 1.4.1.
Group Reference into Lexicons, XRPC API, SDK, and Services and tooling subsections with uppercase headings, and add placeholder pages for the unreleased XRPC API and SDK. Retire the Architecture overview in favour of the Guide and redirect its routes. Make category rows single links that open their page and expand, with an inline chevron, aligned headings, and a shallower nested indent.
…rmation-architecture # Conflicts: # lib/navigation.js
Add a services overview with an architecture diagram, component table, and the single list of running endpoints. Give each component its own integrator-focused page: Certified PDSs, Entryway, Certified Group Service, Relay and Jetstream, Indexer and Hypercerts API, Labelers, and Feed Service. Rewrite the relay page for readers new to AT Protocol infrastructure, drop Hyperindex, and redirect the old service routes.
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
Add row, list, and table layouts to docs-section so each landing section has its own shape: Client Integration as a single row of cards, Reference as a compact link list, and Changes as a status table of component versions.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/changes, with permanent redirects for the previous page and raw Markdown URLs@hypercerts-org/lexiconv1.4.0 schemasValidation
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)/and/changesreturn HTTP 200 with release content; fresh authenticated production build succeedsgit diff --checkKnown warning
/reference/releasespage-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.