Skip to content

docs: add GitBook documentation site - #2

Merged
fadesany merged 20 commits into
mainfrom
docs/gitbook-site
Aug 11, 2026
Merged

fadesany merged 20 commits into
mainfrom
docs/gitbook-site

Conversation

@fadesany

Copy link
Copy Markdown
Contributor

Adds a full GitBook documentation site under docs/, git-synced via .gitbook.yaml (root: ./docs). Nineteen pages across seven sections, one commit per page.

What's here

  • Introduction — What is Charter, The Problem, How It Works.
  • Protocol — Request Lifecycle, Category Mechanics, Approval Threshold Model.
  • Smart Contracts — Overview, treasury, factory. Written from the actual contract source (lib.rs, errors.rs, events.rs), with exact panic conditions, error discriminants, and event tables.
  • For Organization Admins — Getting Started, Setting Up Categories and Approvers, Reading the Public Ledger. Built from the real web UI labels and flows.
  • For Approvers and Requesters — Submitting a Request; Approving, Rejecting, and Cancelling.
  • Developer Guide — Local Setup, Environment Variables, SDK Reference, API Reference.
  • Contributing — How to Contribute.

Sourcing

Every page is built from verified source, not memory:

  • Contract pages pull current function signatures, errors, and events from charter-contract source.
  • SDK Reference mirrors the real client signatures in packages/sdk/src.
  • API Reference uses live responses captured from the deployed indexer (charter-indexer.onrender.com), and documents two genuine read-model limitations the live data exposes: an executed request records one fewer approval than the number who signed (the threshold-meeting approval emits RequestExecuted, not RequestApproved), and requester/memo come back empty because the RequestSubmitted event does not carry them.

Notes

  • GitBook space connection is handled separately on the GitBook side; this PR only lands the repo content and structure.
  • The SDK's TreasuryError/FactoryError enums in packages/sdk/src/types.ts drift from the contract errors.rs. The docs use the contract source as the authority and flag the drift; it will be filed as a separate bug.

@vercel

vercel Bot commented Aug 11, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
app-web Ready Ready Preview Aug 11, 2026 7:04pm

@fadesany
fadesany merged commit b1847c1 into main Aug 11, 2026
4 checks passed
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