chore(docs): Added mkdocs-llmstxt plugin setup for documentation#4248
Merged
ruben-arts merged 6 commits intoprefix-dev:mainfrom Aug 5, 2025
Merged
chore(docs): Added mkdocs-llmstxt plugin setup for documentation#4248ruben-arts merged 6 commits intoprefix-dev:mainfrom
ruben-arts merged 6 commits intoprefix-dev:mainfrom
Conversation
Added mkdocs-llmstxt library as pypi-dependency to the docs feature, so that we can have llmstxt for pixi documentation. --- Reference: https://github.com/pawamoy/mkdocs-llmstxt
Added llmstxt setup for pixi documentation that we want to expose to an LLM as context.
baszalmstra
reviewed
Jul 31, 2025
Contributor
baszalmstra
left a comment
baszalmstra
left a comment
There was a problem hiding this comment.
This looks great in my eyes!
Expanded the markdown descriptions to be more LLM friendly by adding some instructions prompt on what pixi is and how to get started with it right off the bat.
lsetiawan
commented
Aug 1, 2025
|
|
||
| The tool combines dependency management, task running, and environment isolation in a single workflow, | ||
| making it easy to share consistent development environments with others. See other documentation sections | ||
| for further details on how to use the software. |
Contributor
Author
There was a problem hiding this comment.
@baszalmstra I've expanded this section a bit on quick start with pixi. Please let me know if there are any inaccuracies. This example inspired me to expand this: https://github.com/astral-sh/uv/blob/785595bd35790154098beab422662862d655adde/mkdocs.template.yml#L85-L92
Updated mkdocs-llmstxt dependency to use the conda package version. --- Ref: prefix-dev#4248 (comment)
Ran 'pixi run lint' as instructed to fix linting errors
ruben-arts
approved these changes
Aug 5, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds
mkdocs-llmstxtsetup for Pixi documentation so that an LLM can easily use the docs as context without the need for parsing through the whole site. This is merely a proposal and open to any suggestions, questions, or further discussions. Thank you for your consideration and making such an amazing tool!! 😄What is llmstxt?
It is essentially a markdown file that provides LLM friendly content. See https://llmstxt.org. By having this, AI agents can simply have this in their context to be able to generate a more accurate configuration for Pixi or use Pixi without the need of a full blown MCP as stated in #3830. It really servers as a starting point for LLM to get familiar with Pixi.
What is mkdocs-llmstxt?
It is a plugin for generating llmstxt. See https://github.com/pawamoy/mkdocs-llmstxt. Other documentation sites like pydantic has really leveraged this plugin to create llmstxt. This PR is actually inspired by that.
Demo
Below is just a quick screenshot of the output at
http://127.0.0.1:8000/pixi/llms-full.txt.