docs: rewrite gitbook with protocol documentation section#1560
Open
docs: rewrite gitbook with protocol documentation section#1560
Conversation
Cover the IPC protocol across six pages: overview, requirements and guarantees, core mechanisms, architecture, workflows, and security and economics.
Rewrite how-ipc-compares with a structured comparison across scaling approaches, key dimensions, and design trade-offs. Minor edits to use-cases (wording, formatting, title case).
Replace marketing-oriented intro with concise framing of IPC's design properties and a documentation overview linking to the new protocol section.
Add Protocol section and Glossary entry to SUMMARY. Remove old Concepts section, How-It-Works, and Architecture pages whose content is now covered by the protocol docs. Consolidate User/Developer Guides into a single Guides section. Title-case navigation entries.
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
2 participants
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.
Note
Medium Risk
Mostly documentation-only, but the TOC restructure and deletion of legacy concept/overview pages can leave stale internal links (e.g., existing references into removed
concepts/andoverview/architecture.md).Overview
Rewrites the GitBook landing page to emphasize IPC’s core properties and adds a clear “Documentation overview” pointing readers into the new protocol docs.
Introduces a new Protocol section (overview, requirements/guarantees, core mechanisms, architecture, workflows, security/economics) and substantially rewrites How IPC Compares into a structured comparison across scaling approaches, key dimensions, and explicit trade-offs.
Restructures navigation in
SUMMARY.md(new top-level Protocol/Getting Started/Guides/Reference groupings, title-cased entries) and removes several superseded pages underconcepts/and older overview pages, while adding a newreference/glossary.md.Reviewed by Cursor Bugbot for commit 10ef8c3. Bugbot is set up for automated code reviews on this repo. Configure here.