Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ on:
paths:
- 'docs/**'
- 'docs.json'
- 'llms.txt'
pull_request:
branches: [ "main" ]
paths:
- 'docs/**'
- 'docs.json'
- 'llms.txt'

jobs:
validate:
Expand All @@ -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
Expand Down
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -114,7 +116,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)
- 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

Expand Down
6 changes: 6 additions & 0 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

For AI agents, start with the project index at:

- [llms.txt](/llms.txt) (redirects to canonical static text)

## Why Use Ack?

- **Simplify Validation**: Easily handle complex data validation logic.
Expand Down
6 changes: 6 additions & 0 deletions docs/llms.txt.mdx
Original file line number Diff line number Diff line change
@@ -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.
Loading