From ed336f6b85f4a38c78baced14a1a27d0f1c6a81f Mon Sep 17 00:00:00 2001 From: "gregology[bot]" <265422814+gregology[bot]@users.noreply.github.com> Date: Mon, 23 Mar 2026 18:56:24 -0400 Subject: [PATCH] Step 1/1: Add mkdocs-llmstxt plugin and remove hand-written llms.txt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Three changes in the docs/ directory: 1. **docs/requirements.txt** — Add `mkdocs-llmstxt` as a dependency (pinned version). 2. **docs/mkdocs.yml** — Add a `plugins:` section with the `llmstxt` plugin configured as follows: - `markdown_description`: The extended description paragraph from the current hand-written llms.txt ("sctx replaces monolithic instruction files...") - `full_output: llms-full.txt` to generate the concatenated full-text file - `sections`: Map the three sections from the current llms.txt into the plugin config: - "Getting Started": `getting-started.md` with description - "Documentation": `protocol.md`, `cli-reference.md`, `examples.md`, `comparisons.md` with descriptions matching current llms.txt - "Optional": `contributing.md`, `roadmap.md` with descriptions Note: The `search` plugin that MkDocs enables by default will need to be explicitly listed since adding a `plugins:` key overrides the defaults. 3. **docs/llms.txt** — Delete this file. The plugin generates `llms.txt` into the `site/` build output directory, so having a source file with the same name in `docs/` (which is the docs_dir) would conflict. The existing `site_name` ("Structured Context") becomes the `# heading` and `site_description` becomes the `> blockquote` in the generated llms.txt — both are already set in mkdocs.yml. --- docs/llms.txt | 22 ---------------------- docs/mkdocs.yml | 18 ++++++++++++++++++ docs/requirements.txt | 1 + 3 files changed, 19 insertions(+), 22 deletions(-) delete mode 100644 docs/llms.txt diff --git a/docs/llms.txt b/docs/llms.txt deleted file mode 100644 index db1e2f5..0000000 --- a/docs/llms.txt +++ /dev/null @@ -1,22 +0,0 @@ -# Structured Context (sctx) - -> sctx is a Go CLI that delivers scoped, structured context to AI agents via AGENTS.yaml files scattered through a codebase, matching guidance to the specific file being edited. - -sctx replaces monolithic instruction files with distributed AGENTS.yaml files placed throughout a codebase. When an AI agent edits a file, sctx discovers nearby AGENTS.yaml files, filters their instructions by glob patterns and action type, and delivers only the relevant context just-in-time. This ensures agents receive precise, scoped guidance instead of an overwhelming wall of instructions. - -## Getting Started - -- [Installation & Setup](https://sctx.dev/getting-started/): Installation via Homebrew, go install, or binary download; Claude Code integration setup - -## Documentation - -- [AGENTS.yaml Protocol](https://sctx.dev/protocol/): AGENTS.yaml format specification, schema, and resolution algorithm -- [CLI Reference](https://sctx.dev/cli-reference/): CLI commands including hook, context, decisions, validate, init, claude enable/disable -- [Examples](https://sctx.dev/examples/): Real-world patterns for dbt, APIs, React, Terraform, and monorepos -- [Comparisons](https://sctx.dev/comparisons/): How sctx differs from AGENTS.md, MCP, llms.txt, and .cursorrules - -## Optional - -- [Contributing](https://sctx.dev/contributing/): Building, testing, and contributing -- [Roadmap](https://sctx.dev/roadmap/): Planned features for v2 and v3 -- [Source Repository](https://github.com/gregology/sctx): GitHub repository diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 788a0f2..300a4fa 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -36,6 +36,24 @@ theme: icon: repo: fontawesome/brands/github +plugins: + - search + - llmstxt: + markdown_description: | + sctx replaces monolithic instruction files with distributed AGENTS.yaml files placed throughout a codebase. When an AI agent edits a file, sctx discovers nearby AGENTS.yaml files, filters their instructions by glob patterns and action type, and delivers only the relevant context just-in-time. This ensures agents receive precise, scoped guidance instead of an overwhelming wall of instructions. + full_output: llms-full.txt + sections: + Getting Started: + - getting-started.md: Installation via Homebrew, go install, or binary download; Claude Code integration setup + Documentation: + - protocol.md: AGENTS.yaml format specification, schema, and resolution algorithm + - cli-reference.md: CLI commands including hook, context, decisions, validate, init, claude enable/disable + - examples.md: Real-world patterns for dbt, APIs, React, Terraform, and monorepos + - comparisons.md: How sctx differs from AGENTS.md, MCP, llms.txt, and .cursorrules + Optional: + - contributing.md: Building, testing, and contributing + - roadmap.md: Planned features for v2 and v3 + markdown_extensions: - admonition - pymdownx.details diff --git a/docs/requirements.txt b/docs/requirements.txt index a946676..48224d8 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ mkdocs-material==9.6.7 +mkdocs-llmstxt==0.5.0