You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Generate llms.txt and doc-content.txt for AI tools
This commit adds the generations of llms.txt (more robust than what was there)
as well a single docs-content.txt that can be fed to an agent or answer engine
to set context of how to work with Flox.
This does add a Makefile (sorry) because I needed something to run multiple
steps when building the documentaiton site.
The README has been updated to explain Makefile usage (and it's completely optional).
The tools directory is also new, with a small python file to generate the AI indexing files.
The robots.txt that helps the crawlers know where to work is maintained in the
flox/floxwebsite repo.
Convenience script for local development. Generates both AI files after a MkDocs build.
22
+
23
+
**Usage:**
24
+
```bash
25
+
mkdocs build
26
+
./tools/generate_llms_txt.sh
27
+
```
28
+
29
+
## Integration
30
+
31
+
These scripts are automatically run during CI builds in `.github/workflows/ci.yml` to ensure the AI files are always up-to-date with the documentation content.
0 commit comments