Skip to content

docs: developer-first navigation restructure#3

Merged
s-adamantine merged 11 commits into
mainfrom
docs/developer-first-restructure
Feb 16, 2026
Merged

docs: developer-first navigation restructure#3
s-adamantine merged 11 commits into
mainfrom
docs/developer-first-restructure

Conversation

@s-adamantine

@s-adamantine s-adamantine commented Feb 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Restructures the entire documentation to be developer-first. The core change: put practical content before theory, and make every page reachable from the sidebar.

New sidebar structure

Welcome

Understand (5 pages)
  What are Hypercerts?
  Defining Work Scopes
  Why We're Building Hypercerts
  What is Certified?
  Why ATProto?

Build (6 pages)
  How Hypercerts Work
  Quickstart
  Account & Identity Setup
  Creating Your First Hypercert
  Working with Evaluations
  Common Use Cases

Architecture (4 + 2 pages)
  Infrastructure Overview
    ├── Indexers & Discovery
    └── Portability & Scaling
  Architecture Overview
  Data Flow & Lifecycle
  Funding & Tokenization

Tools (4 pages)
  Hypercerts CLI
  Scaffold Starter App
  Hyperboard
  Hyperindex

Reference (5 + 9 pages)
  Lexicons
    General Lexicons
      ├── Shared Definitions
      └── Location
    Hypercerts Lexicons
      ├── Activity Claim
      ├── Contribution
      ├── Evidence
      ├── Measurement
      ├── Evaluation
      ├── Collection
      └── Rights
  Building on Hypercerts
  Testing & Deployment
  Glossary
  FAQ
  Roadmap

What changed

Pages created

  • How Hypercerts Work — merged from "Introduction to Impact Claims" + "The Impact and Work Space" into a practical data model page (record types, ERD, strong references, six dimensions)
  • Defining Work Scopes — merged from "The Impact and Work Space" + "Deep Dive: The Work Scope" into a practical guide with SDK examples
  • Testing & Deployment — merged from "Error Handling & Constraints" + "Testing & Security" (from PR docs: remove smart contract references, add security model, consolidate reference pages #2)

Pages deleted

  • introduction-to-impact-claims.md (merged into How Hypercerts Work)
  • the-impact-and-work-space.md (merged into How Hypercerts Work + Defining Work Scopes)
  • deep-dive-the-work-scope.md (merged into Defining Work Scopes)
  • error-handling.md (merged into Testing & Deployment)
  • testing-and-security.md (merged into Testing & Deployment)
  • infrastructure/blockchain-integration.md (was already a redirect stub)

Pages restored

Pages rewritten

  • Landing page — card links replaced with markdown tables; sections: Start building, Understand, Tools, Reference & Architecture
  • Account & Identity Setup — reframed as post-Quickstart configuration guide; added "Why Certified?" subsection and app.certified namespace
  • Glossary — trimmed from 20 to 15 terms; removed ATProto internals (XRPC, Relay, Repository, SDS); added Hypergoat, Certified; reordered by usefulness
  • FAQ — rewritten to be practical; added "How do I query hypercerts?"; answers link to specific docs

Navigation changes

  • Understand before Build — conceptual context before code
  • "What are Hypercerts?" moved to Understand (conceptual), "How Hypercerts Work" moved to Build (data model with SDK references)
  • Architecture moved up from bottom to after Build (conceptual depth should be adjacent)
  • "Building on Hypercerts" moved from Build to Reference (integration guide, not getting-started)
  • Roadmap moved into Reference (was a standalone item that visually bled into Reference)
  • 9 individual lexicon pages added to sidebar (existed on disk but were unreachable)
  • Security model added to Architecture Overview (moved from deleted Testing & Security page)

No content changes

All Architecture, Tools, Lexicon, and tutorial pages are unchanged — only repositioned in the sidebar.

…uage

- overview.md: 'smart contracts' → 'on-chain logic'
- portability-and-scaling.md: 'smart contracts' → 'on-chain tokens'
- planned-funding-and-tokenization.md: rewritten to remove smart contract
  language throughout, expanded with freezing patterns and cross-layer example
@vercel

vercel Bot commented Feb 16, 2026

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated (UTC)
hypercerts-atproto-documentation Ready Ready Preview, Comment Feb 16, 2026 7:40am

@s-adamantine s-adamantine merged commit f550808 into main Feb 16, 2026
2 checks passed
@s-adamantine s-adamantine deleted the docs/developer-first-restructure branch February 16, 2026 07:59
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