Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create llms.txt file for Mirascope documentation #630

Open
betterthanever2 opened this issue Oct 22, 2024 · 2 comments
Open

Create llms.txt file for Mirascope documentation #630

betterthanever2 opened this issue Oct 22, 2024 · 2 comments
Assignees
Labels
Feature Request New feature or request

Comments

@betterthanever2
Copy link

Description

As Mirascope documentation grows, it becomes harder to navigate and keep up to. There is this thing called llms.txt. They suggest

A proposal to standardise on using an /llms.txt file to provide information to help LLMs use a website at inference time.

Here's the relevant part of the FastHTML documentation that explains it a little more. In short, it's a page in Markdown format that contains the entire documentation and that you can feed to an AI agent, and then ask it (them?) questions about it.

Would be really nice to have.

@betterthanever2 betterthanever2 added the Feature Request New feature or request label Oct 22, 2024
@willbakst
Copy link
Contributor

I'll look into this!

@willbakst willbakst self-assigned this Oct 22, 2024
@willbakst
Copy link
Contributor

Circling back here as I continue to research. One thing I need to figure out is how to do this with mkdocs without impacting the site (e.g. Google really does not like duplicate content, so I need to ensure I do things like remove the .md urls from the sitemap etc.).

Generally, I think including something here to make it easier to port our docs into an LLM is worth doing, so I'll continue to think through this and provide updates as I have them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants