09f36b0550
Update project slogan ( #2000 )
...
Update the project slogan across docs, CLI, and package metadata.
2026-04-24 12:14:23 +08:00
184f0a506e
Update prek slogon ( #1900 )
2026-04-06 18:16:14 +08:00
36ab78a49f
Misc. cleanups ( #1769 )
2026-03-10 15:29:20 +08:00
ec2c03f7c2
Document compatibility with pre-commit ( #1767 )
2026-03-10 13:06:27 +08:00
1539b5a210
Add document about authoring remote hooks ( #1571 )
2026-02-05 17:09:42 +08:00
d548c08361
Add llms.txt generation for LLM-friendly documentation ( #1553 )
...
Closes #1498
Generates `llms.txt` and `llms-full.txt` for the documentation site.
Also generates markdown files at each path (e.g.,
`/configuration/index.md`), enabling LLMs to fetch raw markdown instead
of HTML.
As mentioned in the issue, this wasn't natively possible, since Zensical
doesn't yet support MkDocs's plugin ecosystem. I built
[llmstxt-standalone](https://github.com/shaanmajid/llmstxt-standalone )
to work as a standalone `llms.txt` generator, respecting the config for
[mkdocs-llmstxt](https://github.com/pawamoy/mkdocs-llmstxt ).
- Configure llmstxt plugin in mkdocs.yml with section structure
- Add `docs-build` and `docs-compile` mise tasks
- Update CI to run llmstxt-standalone after zensical build
Note: the generated files are not served or visible when using `zensical
serve`, but will be generated and published to docs site as part of the
`publish-docs` workflow.
Preview:
-
[llms.txt](https://gist.github.com/shaanmajid/767af572028a23ec4d0bfac2015011a5#file-llms-txt )
-
[llms-full.txt](https://gist.github.com/shaanmajid/767af572028a23ec4d0bfac2015011a5#file-llms-full-txt )
---------
Co-authored-by: Jo <10510431+j178@users.noreply.github.com >
2026-02-04 13:58:36 +08:00
4525825ea8
docs: remove todo.md ( #1501 )
...
- Remove `todo.md` as remaining items have been addressed or documented
elsewhere.
- Move note to `diff.md` that `pre-commit hazmat` subcommand (v4.5.0) is
not implemented.
2026-01-31 22:34:14 +08:00
ccc8f92ca7
Remove mkdocs hooks ( #1424 )
2026-01-20 19:50:07 +08:00
52c20ab065
Document language support details ( #1380 )
2026-01-17 17:48:11 +08:00
02414edb56
Render changelog in document site ( #1248 )
...
# Conflicts:
# .github/workflows/release.yml
2025-12-22 00:49:01 +08:00
c8b46885be
Add docker integration docs ( #1254 )
2025-12-22 00:34:51 +08:00
c7545d8edb
Improve documentation for priority ( #1245 )
2025-12-20 12:46:10 +08:00
9a720e94d4
Add favicon for docs website ( #1187 )
2025-12-04 06:31:25 +08:00
1bb181ffa3
Add a FAQ page explaning prek install --install--hooks ( #1162 )
2025-11-29 19:52:52 +08:00
a1b6d2821e
Refactor bloat-check and hotpath workflow ( #990 )
...
* Refactor `bloat-check` and `hotpath` workflow
* Use faster profiling profile
* Fix template injection issue
* Tweak
2025-10-29 17:00:38 +08:00
9c6987fe40
Add a page about "Quick start" ( #934 )
2025-10-19 21:34:56 +08:00
a95a3d0912
Deduplicate docs between README and MkDocs site ( #792 )
2025-09-25 11:28:29 +08:00
de9107f2bd
Add and use a smaller webp version of logo ( #758 )
2025-09-18 21:39:06 +08:00
6f0a7da41b
Generate cli reference ( #707 )
...
* Generate cli reference
* Fix lint
2025-09-10 22:05:05 +08:00
cbddcb9fb6
Add docs about configuration ( #703 )
2025-09-10 15:45:52 +08:00
2ebf0084fa
Add docs about debugging ( #702 )
2025-09-10 15:16:34 +08:00
7fc8d4588d
Add docs about TODOs ( #679 )
2025-09-09 14:46:20 +08:00
cd2cb80c9f
Add docs about builtin hooks ( #678 )
2025-09-09 11:59:43 +08:00
5cbdeecccb
Publish docs ( #627 )
2025-09-06 18:08:56 +08:00
Jo
Shaan Majid
Francesco Zardi
Álvaro Mondéjar Rubio
Aarni Koskela