# Linda's Thally Demo For Vale

> A demo docs site built with Thally for a Developer Experience & Documentation Engineer assessment. It documents Vale, the open-source prose linter, for writers and developers who want to catch style issues automatically.

- Documentation: https://linda-s-thally-demo-for-vale.thally.app
- GitHub: https://github.com/Linda-Ikechukwu/linda-s-thally-demo-for-vale
- Full docs for LLMs: https://linda-s-thally-demo-for-vale.thally.app/llms-full.txt
- Agent discovery (ai.txt): https://linda-s-thally-demo-for-vale.thally.app/ai.txt
- Structured docs index (JSON): https://linda-s-thally-demo-for-vale.thally.app/api/docs-index
- OpenAPI spec: https://linda-s-thally-demo-for-vale.thally.app/openapi.yaml

## For AI agents

Every page supports content negotiation on its human URL:
- JSON API: append `?format=json` or send `Accept: application/json`
- JSON-LD: append `?format=ldjson` or send `Accept: application/ld+json`
- Markdown: append `?format=md` or send `Accept: text/markdown`
- Per-page API: https://linda-s-thally-demo-for-vale.thally.app/api/docs/{page-id}
- Search API: https://linda-s-thally-demo-for-vale.thally.app/api/search?q={query}
- Capability manifest (skill): https://linda-s-thally-demo-for-vale.thally.app/skill.md
- Agent guidance (editing these docs): https://linda-s-thally-demo-for-vale.thally.app/AGENTS.md
- MCP server (attach docs as native tools): https://linda-s-thally-demo-for-vale.thally.app/api/mcp
- Agent readiness: https://linda-s-thally-demo-for-vale.thally.app/api/agent-readiness

### Recommended workflow

1. Use this index, the search API, or `search_sections` / `search_docs` before choosing a page.
2. Read the smallest set of relevant pages and follow their prerequisite links.
3. Treat the published docs as the source of truth. Label inferences and say when evidence is missing.
4. Cite the canonical human page URLs, not only API endpoints.
5. Use `/AGENTS.md` before editing a repository. The public MCP server is read-only.

## Docs

### Get started

- [Introduction](https://linda-s-thally-demo-for-vale.thally.app/): What Vale does, who it's for, and how it works.
- [Quickstart](https://linda-s-thally-demo-for-vale.thally.app/quickstart): Install Vale and run your first lint against Google's style guide.

### Guides

- [Add your style guide](https://linda-s-thally-demo-for-vale.thally.app/guides/add-your-style-guide): Turn your organization's style guide into Vale rules and share them across your repositories.