Skip to content

Commit ef8fb8c

Browse files
authored
Merge pull request #20 from HaoZeke/docs/manual-discovery
docs(manual): point the index at the discovery files
2 parents f46b4d3 + f85acb2 commit ef8fb8c

4 files changed

Lines changed: 46 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,9 @@ All notable changes to this project are documented here.
158158
`--easystack`, `--easyconfigs`, `--installed`, `--profile`,
159159
`--resources`, `--node`, `--job-memory` (alias `--mib-per-job`),
160160
`--hooks`, `--parallel`, and `--max-parallel`.
161+
- The manual index links `llms.txt`, `llms-full.txt`, `AGENTS.md`, the
162+
skills directory, and `server.json`, the same discovery files the
163+
README names. Client setup stays on the Model Context Protocol page.
161164
- How to split one Jenkins build list into shards that build at the
162165
same time, with the shared dependencies in a prelude.
163166
- How to plan software-layer pull requests whose builds do not overlap,

‎docs/orgmode/index.org‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -389,6 +389,20 @@ Rohit Goswami, eb-stack (source revision <commit>), https://github.com/HaoZeke/e
389389

390390
MIT License. See [[https://github.com/HaoZeke/eb-stack/blob/main/LICENSE][LICENSE]] in the repository.
391391

392+
* Discovery
393+
394+
[[https://github.com/HaoZeke/eb-stack/blob/main/llms.txt][llms.txt]] indexes
395+
this manual.
396+
[[https://github.com/HaoZeke/eb-stack/blob/main/llms-full.txt][llms-full.txt]]
397+
repeats every page in one file.
398+
[[https://github.com/HaoZeke/eb-stack/blob/main/AGENTS.md][AGENTS.md]] lists
399+
the build, test, lint, and docs commands. The skills for inspect, plan,
400+
bump, a stack SBOM, pull-request overlap, and the stdio server are under
401+
[[https://github.com/HaoZeke/eb-stack/tree/main/skills][skills/]]. The Model
402+
Context Protocol manifest is
403+
[[https://github.com/HaoZeke/eb-stack/blob/main/server.json][server.json]].
404+
Client configuration is the [[file:reference/mcp.org][server page]].
405+
392406
* Build these docs
393407

394408
#+begin_src bash

‎llms-full.txt‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,20 @@ Rohit Goswami, eb-stack (source revision <commit>), https://github.com/HaoZeke/e
157157

158158
MIT License. See [LICENSE](https://github.com/HaoZeke/eb-stack/blob/main/LICENSE) in the repository.
159159

160+
# Discovery
161+
162+
[llms.txt](https://github.com/HaoZeke/eb-stack/blob/main/llms.txt) indexes
163+
this manual.
164+
[llms-full.txt](https://github.com/HaoZeke/eb-stack/blob/main/llms-full.txt)
165+
repeats every page in one file.
166+
[AGENTS.md](https://github.com/HaoZeke/eb-stack/blob/main/AGENTS.md) lists
167+
the build, test, lint, and docs commands. The skills for inspect, plan,
168+
bump, a stack SBOM, pull-request overlap, and the stdio server are under
169+
[skills/](https://github.com/HaoZeke/eb-stack/tree/main/skills). The Model
170+
Context Protocol manifest is
171+
[server.json](https://github.com/HaoZeke/eb-stack/blob/main/server.json).
172+
Client configuration is the [server page](https://eb-stack.rgoswami.me/reference/mcp.html.md).
173+
160174
# Build these docs
161175

162176
```bash

‎tests/public_metadata.rs‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -592,4 +592,19 @@ fn discovery_metadata_uses_real_index_terms() {
592592
] {
593593
assert!(readme.contains(needle), "README must point at {needle}");
594594
}
595+
596+
let index = std::fs::read_to_string(root.join("docs/orgmode/index.org")).expect("read index");
597+
for needle in [
598+
"llms.txt",
599+
"llms-full.txt",
600+
"AGENTS.md",
601+
"server.json",
602+
"skills/",
603+
"reference/mcp.org",
604+
] {
605+
assert!(
606+
index.contains(needle),
607+
"manual index must point at {needle}"
608+
);
609+
}
595610
}

0 commit comments

Comments
 (0)