Skip to content

docs: publish llms.txt and llms-full.txt for AI agents - #57

Merged
Insei merged 2 commits into
mainfrom
llms-txt
Oct 19, 2026
Merged

Insei merged 2 commits into
mainfrom
llms-txt

Conversation

@Insei

@Insei Insei commented Oct 19, 2026

Copy link
Copy Markdown
Owner

The documentation in the llms.txt format, for the agents that read the documentation of a library before writing the code.

  • llms.txt (the index of the pages with descriptions) and llms-full.txt (the whole documentation as one Markdown file) are built by mkdocs-llmstxt for every version.
  • The links point to the pages of the deployed version: the docs workflow sets LLMSTXT_BASE_URL to /X.Y/ for the release tags and to /dev/ for main. The files of the latest version are also copied to the root of the site.
  • "For AI agents" page: how to install the skill and where to find llms.txt; a link from README.

Insei added 2 commits October 19, 2026 06:53
…umentation

Signed-off-by: Dmitriy Aleksandrov <goodmobiledevices@gmail.com>
Signed-off-by: Dmitriy Aleksandrov <goodmobiledevices@gmail.com>
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.92%. Comparing base (dc0a427) to head (714928a).

Additional details and impacted files
@@             Coverage Diff             @@
##              main      #57      +/-   ##
===========================================
- Coverage   100.00%   99.92%   -0.08%     
===========================================
  Files           32       32              
  Lines         2638     2638              
===========================================
- Hits          2638     2636       -2     
- Misses           0        2       +2     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions

Copy link
Copy Markdown
Contributor

Benchmark diff: dc0a427 → 0bdad9d (10 runs)

goos: linux
goarch: amd64
pkg: github.com/insei/tinyconf/v2
cpu: AMD EPYC 9V45 96-Core Processor                
                    │  base.txt   │              head.txt              │
                    │   sec/op    │   sec/op     vs base               │
Parse-4               1.800µ ± 2%   1.830µ ± 2%  +1.67% (p=0.027 n=10)
Parse_SubConfig-4     794.1n ± 1%   803.6n ± 0%  +1.20% (p=0.006 n=10)
Current-4             44.00n ± 1%   43.78n ± 1%       ~ (p=0.780 n=10)
Current_SubConfig-4   64.33n ± 3%   62.95n ± 1%       ~ (p=0.110 n=10)
geomean               252.2n        252.3n       +0.04%

                    │    base.txt    │               head.txt                │
                    │      B/op      │     B/op      vs base                 │
Parse-4               1.344Ki ± 0%     1.344Ki ± 0%       ~ (p=1.000 n=10) ¹
Parse_SubConfig-4       392.0 ± 0%       392.0 ± 0%       ~ (p=1.000 n=10) ¹
Current-4               0.000 ± 0%       0.000 ± 0%       ~ (p=1.000 n=10) ¹
Current_SubConfig-4     0.000 ± 0%       0.000 ± 0%       ~ (p=1.000 n=10) ¹
geomean                            ²                 +0.00%                ²
¹ all samples are equal
² summaries must be >0 to compute geomean

                    │   base.txt   │              head.txt               │
                    │  allocs/op   │ allocs/op   vs base                 │
Parse-4               18.00 ± 0%     18.00 ± 0%       ~ (p=1.000 n=10) ¹
Parse_SubConfig-4     10.00 ± 0%     10.00 ± 0%       ~ (p=1.000 n=10) ¹
Current-4             0.000 ± 0%     0.000 ± 0%       ~ (p=1.000 n=10) ¹
Current_SubConfig-4   0.000 ± 0%     0.000 ± 0%       ~ (p=1.000 n=10) ¹
geomean                          ²               +0.00%                ²
¹ all samples are equal
² summaries must be >0 to compute geomean

pkg: github.com/insei/tinyconf/v2/drivers
                │  base.txt   │           head.txt            │
                │   sec/op    │   sec/op     vs base          │
Parse_Drivers-4   28.64µ ± 1%   28.26µ ± 2%  ~ (p=0.055 n=10)

                │   base.txt   │            head.txt            │
                │     B/op     │     B/op      vs base          │
Parse_Drivers-4   25.14Ki ± 0%   25.14Ki ± 0%  ~ (p=1.000 n=10)

                │  base.txt  │            head.txt            │
                │ allocs/op  │ allocs/op   vs base            │
Parse_Drivers-4   408.0 ± 0%   408.0 ± 0%  ~ (p=1.000 n=10) ¹
¹ all samples are equal

@Insei
Insei merged commit 1314406 into main Oct 19, 2026
4 checks passed
@Insei
Insei deleted the llms-txt branch October 19, 2026 03:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants