Repository navigation
docs: correct documentation against the code and restructure the README - #307
Merged
Merged
Conversation
Audit every user-facing document against the current code and fix inaccuracies: listener defaults, chat enablement, secret-file rules, setup and recovery flows, MCP OAuth, HTTP routes, alert variable semantics, ingest batching and admission, Collector examples, testing and release notes, and llms.txt. Generated pages change through their generator sources. Restructure the README for a first-time visitor: a System overview screenshot (light and dark), what Fanout includes and its maturity, a quick start covering Docker, the native installer, telemetry, chat, and MCP, then comparison, architecture, and configuration summaries. Remove the unofficial throughput figure. Move ingest internals to the storage model page, DuckDB sizing to the configuration reference, and dotenv, generated-asset, and hook details to CONTRIBUTING.
Alerts evaluate service span and log rollups, not OTLP metric values. Ingest authentication reads the token hash from the control database on every export, so SQLite holds no telemetry but is not independent of ingest.
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
Accuracy. Every user-facing document was audited against the current code after the environment-only configuration change (#305), and each inaccuracy was fixed. Generated pages change through their generator sources.
127.0.0.1:7520; the image setsFANOUT_ADDR=:7520.FANOUT_AI_PROVIDERplus that provider's key; unselected providers' values and_FILEforms are ignored.llms.txt).README. Restructured for a first-time visitor (373 to 239 lines): a System overview screenshot in light and dark, what Fanout includes and its preview maturity, a quick start covering Docker, the native installer, telemetry, chat, and MCP, then comparison, architecture, and configuration summaries. The unofficial throughput figure is removed. Ingest internals moved to the storage model page, DuckDB sizing to the configuration reference, and dotenv, generated-asset, and hook details to CONTRIBUTING.
Verification
just checkjust test-racewhen auth, API, ingest, query, MCP, or agent paths changed (documentation and comments only)just docs-generate-checkand offline link check pass