Rebuild TruthGate documentation#17
Merged
Merged
Conversation
magiccodingman
marked this pull request as ready for review
July 25, 2026 18:46
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.
What changed
This PR rebuilds TruthGate's public documentation around the current Docker appliance and current source behavior.
README
/ipfs/,/ipns/,/api/v0/, and WebUI routingcontent/images/demo/next to the features they demonstrateDocumentation structure
Adds a versioned
docs/tree with anindex.mdin every directory:docs/setup/— installation, first run, networking, configuration, storage, updates, and legacy migrationdocs/concepts/— architecture, request routing, pinning/IPNS/publishing, security boundaries, and persistencedocs/api/— authentication, Kubo proxy, domain metadata, errors, and rate limitsdocs/tgp/— rationale, normative v1 specification, client behavior, publisher workflow, gateway behavior, legal limitations, notice template, and FAQdocs/reference/— environment variables, ports and paths, Kubo defaults, image tags, and rate-limit defaultsdocs/developer/— Compose model, Rider setup, Visual Studio placeholder, testing, and documentation contribution rulesDeveloper workflow
Documents the tested development model:
The production definition is intentionally first and the development file is an override. New production requirements belong in
compose.yaml;compose.dev.yamlshould contain only development differences.The Rider guide documents:
truthgate./compose.yaml; ./compose.dev.yaml;in that orderThe Visual Studio page is explicitly marked as not yet verified rather than inventing IDE instructions.
TGP
TGP is now documented as a real protocol instead of being mixed into product copy.
1tgp.jsonfields, client rules, caching, failure behavior, schema, and conformance are definedCompatibility and validation
DOCKER.mdas a short compatibility page pointing to the new versioned guidesscripts/check-docs.pyindex.mddocs/index.mdSource alignment
Exact values were reconciled against current
master, including:Planned or unverified behavior is labeled rather than written as implemented fact.
Validation
Local documentation validation passed for 45 Markdown files:
This PR intentionally changes documentation and documentation CI only. It does not change the TruthGate application, Docker runtime behavior, Compose definitions, or release pipeline.