docs: add GitBook documentation site - #2
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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.
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
lib.rs,errors.rs,events.rs), with exact panic conditions, error discriminants, and event tables.Sourcing
Every page is built from verified source, not memory:
charter-contractsource.packages/sdk/src.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 emitsRequestExecuted, notRequestApproved), andrequester/memocome back empty because theRequestSubmittedevent does not carry them.Notes
TreasuryError/FactoryErrorenums inpackages/sdk/src/types.tsdrift from the contracterrors.rs. The docs use the contract source as the authority and flag the drift; it will be filed as a separate bug.