Skip to content

bug: Ordering of pages in llms.txt and llms-full.txt is alphabetical #21

@stichbury

Description

@stichbury

Description of the bug

Pages are added alphabetically per section rather than in the order specified.

To Reproduce

My mkdocs.yml is as follows:

 - llmstxt: # https://pypi.org/project/mkdocs-llmstxt/
      markdown_description: Vizro project docs
      full_output: llms-full.txt
      sections:
        "TUTORIALS":
          - pages/tutorials/first-dashboard.md: "A quickstart dashboard"
          - pages/tutorials/explore-components.md: "An in-depth tutorial to introduce Vizro's key features"
        "FUNDAMENTALS":
          - pages/user-guides/install.md: "Install Vizro"
          - pages/user-guides/dashboard.md: "Dashboard basics"
          - pages/user-guides/pages.md: "Pages"
          - pages/user-guides/run-deploy.md: "Run or deploy dashboards"

But when you look at llms.txt

# Vizro

Vizro project docs

## TUTORIALS

- [Explore Vizro](https://vizro.readthedocs.io/en/stable/pages/tutorials/explore-components/index.md): An in-depth tutorial to introduce Vizro's key features
- [A first dashboard](https://vizro.readthedocs.io/en/stable/pages/tutorials/first-dashboard/index.md): A quickstart dashboard

## FUNDAMENTALS

- [Dashboard](https://vizro.readthedocs.io/en/stable/pages/user-guides/dashboard/index.md): Dashboard basics
- [Install Vizro](https://vizro.readthedocs.io/en/stable/pages/user-guides/install/index.md): Install Vizro
- [Page](https://vizro.readthedocs.io/en/stable/pages/user-guides/pages/index.md): Pages
- [Run or deploy dashboards](https://vizro.readthedocs.io/en/stable/pages/user-guides/run-deploy/index.md): Run or deploy dashboards

Likewise the llms-full.txt has added the content in alphabetical order.

Expected behavior

I thought part of the purpose of llms.txt was to help the LLM see the priority order of the pages and understand which builds on which. By alphabetising them, the plugin is subverting the order chosen and thus breaking the ideal, no? I would prefer to see the output as specified anyway, or have a flag to choose it if it isn't the default.

Environment information

Additional context

You can see my PR on the Vizro docs to use your plugin here: mckinsey/vizro#1321

Thank you by the way, it's great!

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions