Skip to content

Docs for AI agents: skill and llms.txt; rewrite Why tinyconf - #54

Closed
Insei wants to merge 5 commits into
mainfrom
llm-docs
Closed

Insei wants to merge 5 commits into
mainfrom
llm-docs

Conversation

@Insei

@Insei Insei commented Oct 19, 2026

Copy link
Copy Markdown
Owner

Docs for AI agents and the new "Why tinyconf?".

  • skills/tinyconf/SKILL.md: the skill in the Agent Skills format — the rules of v2 (/v2 imports, Parse(ctx, conf)), the tags, three complete programs (a service with four drivers, sub configs with Current and Subscribe, the logger from the config), the drivers with their options, the common mistakes.
  • scripts/check-skill.sh and a CI step build the programs of the skill against the code of the repository, so the skill can not describe the API that does not exist. The programs were also run by hand: the required field error, the priority of the flags over the environment, Sources, GenDoc, the deferred logger.
  • llms.txt and llms-full.txt by mkdocs-llmstxt for every version of the documentation; the links point to the pages of the deployed version (LLMSTXT_BASE_URL is set by the docs workflow), 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.
  • "Why tinyconf?" is rewritten around for whom and for what: modular services, reloading at runtime, many sources, generated templates; the main strengths with code; the comparison table, the limitations and the migration are kept.
  • README: the new description and the links for AI agents.

Insei added 4 commits October 19, 2026 06:41
…rograms

Signed-off-by: Dmitriy Aleksandrov <goodmobiledevices@gmail.com>
Signed-off-by: Dmitriy Aleksandrov <goodmobiledevices@gmail.com>
…the skill for AI agents

Signed-off-by: Dmitriy Aleksandrov <goodmobiledevices@gmail.com>
Signed-off-by: Dmitriy Aleksandrov <goodmobiledevices@gmail.com>
@github-actions

github-actions Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Benchmark diff: 5f9bf99 → 7ebe7ae (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.894µ ± 4%   1.937µ ± 2%       ~ (p=0.165 n=10)
Parse_SubConfig-4     840.6n ± 1%   845.8n ± 2%       ~ (p=0.089 n=10)
Current-4             46.12n ± 1%   46.58n ± 1%       ~ (p=0.086 n=10)
Current_SubConfig-4   66.73n ± 1%   66.53n ± 0%       ~ (p=0.218 n=10)
geomean               264.6n        266.9n       +0.89%

                    │    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   30.51µ ± 3%   30.63µ ± 2%  ~ (p=0.971 n=10)

                │   base.txt   │            head.txt            │
                │     B/op     │     B/op      vs base          │
Parse_Drivers-4   25.14Ki ± 0%   25.14Ki ± 0%  ~ (p=0.656 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

…s are called

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 100.00%. Comparing base (7e2b443) to head (b92bf79).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #54   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           32        32           
  Lines         2630      2638    +8     
=========================================
+ Hits          2630      2638    +8     

☔ 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.

@Insei

Insei commented Oct 19, 2026

Copy link
Copy Markdown
Owner Author

Split into separate pull requests by topic: the flaky test fix, the skill for AI agents, llms.txt, Why tinyconf.

@Insei Insei closed this Oct 19, 2026
@Insei
Insei deleted the llm-docs branch October 19, 2026 03:49
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