From 645378a18ed2bf1b56c38a1264624ed00d208a8a Mon Sep 17 00:00:00 2001 From: Vishal Rana Date: Tue, 8 Sep 2026 23:45:55 -0700 Subject: [PATCH 1/2] chore: add context7.json for AI coding agents Context7 is what many AI coding agents query for library documentation. Fanout is not indexed there yet; this lands the parsing config before submission so the first parse is scoped correctly rather than being corrected afterwards. Indexing covers the Starlight docs under site/src/content/docs, the operational notes in docs/, and the README. It excludes the internal superpowers notes, generated media and diagrams, sample data, and the experiments and demo directories. `rules` records what an agent most easily gets wrong: that this is a single process rather than a stack to assemble, that ingest is plain OTLP on 7520, which store is authoritative versus rebuildable, and that consumers go through the typed observability contract rather than raw SQL. Claiming the library additionally needs `url` and `public_key` from the Context7 dashboard, which can only be generated after the repository is submitted; that is a follow-up. Claude-Session: https://claude.ai/code/session_01ABWLbEypvJUVLLY26pHxtT --- context7.json | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 context7.json diff --git a/context7.json b/context7.json new file mode 100644 index 000000000..7f8777d9a --- /dev/null +++ b/context7.json @@ -0,0 +1,25 @@ +{ + "$schema": "https://context7.com/schema/context7.json", + "projectTitle": "Fanout", + "description": "Single-binary, agent-native OpenTelemetry investigation. Ingests OTLP, stores Parquet, queries with embedded DuckDB.", + "branch": "main", + "folders": ["site/src/content/docs", "docs", "README.md"], + "excludeFolders": [ + "docs/superpowers", + "docs/media", + "docs/diagrams", + "site/node_modules", + "site/dist", + "data", + "bin", + "experiments", + "demo" + ], + "rules": [ + "Fanout is one Go process with no external dependencies to operate. There is no separate ingester, query service, metadata database, object store, or dashboard server to deploy.", + "Telemetry arrives over OTLP/gRPC or OTLP/HTTP on port 7520. Point an OpenTelemetry SDK or Collector at it; do not invent a bespoke ingest protocol.", + "Parquet is the authoritative telemetry store. DuckDB query state and rollups are rebuildable from it, and SQLite is reserved for transactional product state.", + "Fanout exposes an MCP server, and the browser client, the in-process agent and any external MCP host all reach the same typed observability contract rather than issuing raw SQL.", + "Configuration is by `FANOUT_*` environment variables or a YAML file; see fanout.example.yaml. The Go module path is `github.com/labstack/fanout`." + ] +} From c5a694c31a53a1c8b77b84d0ac81dbfbd09d80ed Mon Sep 17 00:00:00 2001 From: Vishal Rana Date: Tue, 8 Sep 2026 23:57:27 -0700 Subject: [PATCH 2/2] chore: exclude only what folders can actually reach MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Six of the nine excluded paths — site/node_modules, site/dist, data, bin, experiments and demo — sit outside the three entries in `folders`, and a non-empty `folders` already confines the scan to those. They could never exclude anything. Two of them could do damage. Context7 matches these entries as regular expressions against paths, so unanchored `data` also matches reference/data-layout, and `bin` matches explanation/why-one-binary: the storage-layout reference and the single-binary explainer, the two pages the rules above them point agents at, dropped silently from the index with nothing to report the exclusion. Keep the three that are load-bearing and add docs/benchmarks, which is internal engineering material of the same class as docs/superpowers — an implementation comparison and four raw .json/.log artifacts. An agent asking how to run Fanout should not be served prose about rejected transport implementations. Claude-Session: https://claude.ai/code/session_014UGBcvMuCtZnsTTdVoQgMo --- context7.json | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/context7.json b/context7.json index 7f8777d9a..fe906ee4e 100644 --- a/context7.json +++ b/context7.json @@ -8,12 +8,7 @@ "docs/superpowers", "docs/media", "docs/diagrams", - "site/node_modules", - "site/dist", - "data", - "bin", - "experiments", - "demo" + "docs/benchmarks" ], "rules": [ "Fanout is one Go process with no external dependencies to operate. There is no separate ingester, query service, metadata database, object store, or dashboard server to deploy.",