From 4379e12fb74e66295e6662fb83d5d96ce4dbe834 Mon Sep 17 00:00:00 2001 From: Leo Farias Date: Tue, 3 Mar 2026 12:36:44 -0500 Subject: [PATCH 1/2] docs: add llms route and ci checks --- .github/workflows/docs.yml | 13 +++++++++++++ README.md | 5 ++++- docs/index.mdx | 6 ++++++ docs/llms.txt.mdx | 6 ++++++ 4 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 docs/llms.txt.mdx diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3babed33..e2efe512 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -6,11 +6,13 @@ on: paths: - 'docs/**' - 'docs.json' + - 'llms.txt' pull_request: branches: [ "main" ] paths: - 'docs/**' - 'docs.json' + - 'llms.txt' jobs: validate: @@ -25,6 +27,17 @@ jobs: - name: Install docs.page CLI run: npm install -g @docs.page/cli + + - name: Verify llms.txt static redirect + run: | + test -s llms.txt || { + echo "llms.txt is missing or empty." + exit 1 + } + grep -q '^redirect: https://raw.githubusercontent.com/btwld/ack/main/llms.txt$' docs/llms.txt.mdx || { + echo "docs/llms.txt.mdx must redirect to the canonical raw llms.txt URL." + exit 1 + } - name: Validate documentation run: npx @docs.page/cli check diff --git a/README.md b/README.md index c97056ce..50af43eb 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,10 @@ if (result.isOk) { ## Documentation -Detailed documentation is available at [docs.page/btwld/ack](https://docs.page/btwld/ack). +Documentation endpoints: +- Human docs: [docs.page/btwld/ack](https://docs.page/btwld/ack) +- Agent-oriented route (redirects to static text): [docs.page/btwld/ack/llms.txt](https://docs.page/btwld/ack/llms.txt) +- Canonical static text: [raw.githubusercontent.com/btwld/ack/main/llms.txt](https://raw.githubusercontent.com/btwld/ack/main/llms.txt) ## Development diff --git a/docs/index.mdx b/docs/index.mdx index 29a7b401..4ceea2d2 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -3,6 +3,12 @@ title: Overview --- Ack is a schema validation library for Dart and Flutter that helps you validate data with a simple, fluent API. Ack is short for "acknowledgment". +## LLM Context + +Machine-readable project context is available at: + +- [llms.txt](/llms.txt) (redirects to canonical static text) + ## Why Use Ack? - **Simplify Validation**: Easily handle complex data validation logic. diff --git a/docs/llms.txt.mdx b/docs/llms.txt.mdx new file mode 100644 index 00000000..dc8cb83f --- /dev/null +++ b/docs/llms.txt.mdx @@ -0,0 +1,6 @@ +--- +title: llms.txt +redirect: https://raw.githubusercontent.com/btwld/ack/main/llms.txt +--- + +This route redirects to the canonical static `llms.txt` file. From 1a8cd6c1f69709fd2cb0898a511f0f10732174eb Mon Sep 17 00:00:00 2001 From: Leo Farias Date: Tue, 3 Mar 2026 12:39:32 -0500 Subject: [PATCH 2/2] docs: clarify llms.txt entrypoint for agents --- README.md | 6 ++++-- docs/index.mdx | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 50af43eb..63ac6f29 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,8 @@ Ack is a schema validation library for Dart and Flutter that helps you validate data with a simple, fluent API. Ack is short for "acknowledge". +For AI agents: start at [`/llms.txt`](https://docs.page/btwld/ack/llms.txt). + ## Why Use Ack? - **Simplify Validation**: Easily handle complex data validation logic @@ -116,8 +118,8 @@ if (result.isOk) { Documentation endpoints: - Human docs: [docs.page/btwld/ack](https://docs.page/btwld/ack) -- Agent-oriented route (redirects to static text): [docs.page/btwld/ack/llms.txt](https://docs.page/btwld/ack/llms.txt) -- Canonical static text: [raw.githubusercontent.com/btwld/ack/main/llms.txt](https://raw.githubusercontent.com/btwld/ack/main/llms.txt) +- AI agent index (stable URL): [docs.page/btwld/ack/llms.txt](https://docs.page/btwld/ack/llms.txt) +- Canonical plaintext source: [raw.githubusercontent.com/btwld/ack/main/llms.txt](https://raw.githubusercontent.com/btwld/ack/main/llms.txt) ## Development diff --git a/docs/index.mdx b/docs/index.mdx index 4ceea2d2..aad13a9d 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -5,7 +5,7 @@ Ack is a schema validation library for Dart and Flutter that helps you validate ## LLM Context -Machine-readable project context is available at: +For AI agents, start with the project index at: - [llms.txt](/llms.txt) (redirects to canonical static text)