Skip to content

add llms.txt to repo #22298

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

Merged
merged 14 commits into from
Apr 2, 2025
Merged

Conversation

sarahsanders-docker
Copy link
Collaborator

@sarahsanders-docker sarahsanders-docker commented Mar 24, 2025

Description

Related issues or tickets

https://docker.atlassian.net/browse/ENGDOCS-2454

Reviews

  • Technical review
  • Editorial review
  • Product review

Sorry, something went wrong.

@github-actions github-actions bot added hugo Updates related to hugo area/config labels Mar 24, 2025
Copy link

netlify bot commented Mar 24, 2025

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 5f84022
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/67e5635e71a7d0000836467c
😎 Deploy Preview https://deploy-preview-22298--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sarahsanders-docker sarahsanders-docker changed the title draft: add llms.txt to repo add llms.txt to repo Mar 26, 2025
@sarahsanders-docker sarahsanders-docker marked this pull request as ready for review March 26, 2025 17:52
@sarahsanders-docker sarahsanders-docker requested a review from a team March 26, 2025 17:52
@sarahsanders-docker sarahsanders-docker changed the title add llms.txt to repo add md files for llms Mar 26, 2025
@craig-osterhout
Copy link
Contributor

It's looking good.
One blocker: The button appears on top of the header bar when scrolling down.

Some nits to consider, but not blockers:
The button text is "Copy page", but only one option is about copying. Maybe call it "Page options" or something more umbrella-y.
Can the copy success be more like the codeblock copy and not a blocking modal.
The bold text in the dropdown items feels too strong and is different than the left-nav dropdown component.
The carrot is a different style than the left-nav dropdown component.
The description text seems redundant for each item and can maybe be removed.
The verb in "Search Docs AI" is inconsistent with "Ask AI". Also the description text uses a different verb, "Search Docs AI" vs. "Ask question with Docs AI".
If intended for LLM scrapers, does it need to be so prominent? To be blunt, if the use-case is for LLM scrapers and based on many of the proposed standards, it feels like this should just be an /llms.txt at the root and be invisible to users, like our /sitemap.xml and /robots.txt.

@sarahsanders-docker sarahsanders-docker changed the title add md files for llms add llms.txt to repo Mar 26, 2025
@sarahsanders-docker
Copy link
Collaborator Author

sarahsanders-docker commented Mar 26, 2025

all feedback addressed!

I had been a bit confused by the standard when we discussed in Docs huddle. I first though llms.txt was supposed to be at the page level. But after doing some more digging, the standard proposes that:

  • llms.txt is one file that is reserved for scraping the entire site (see: https://docs.stripe.com/llms.txt), but some sites (Stripe, Cloudflare) have this visible, not hidden like robots.txt. Other sites have it hidden. There isn't a real standard for whether this should be hidden or available somewhere on the site. I guess this should be a discussion whether we expose this file (I have it in the footer right now) @usha-mandya @aevesdocker any strong feelings on whether to keep the llms.txt file in the footer exposed, or hide it?

the individual page level copy as markdown/view plaintext/ask AI options are so that actual users can copy the markdown files into an LLM of their choice. this is not part of the llms.txt standard, but rather a user experience/developer experience improvement in general. I am in strong support of giving users the flexibility to use docs in the LLM of their choice (by copying the markdown file or viewing in plaintext/copying).

@aevesdocker
Copy link
Contributor

I wonder if you want to make the option description the actual option, otherwise it's a bit repetitive and is a lot of text all in that little dropdown. You could make it more efficient with:

  • Copy page as Markdown for LLMs
  • View page as plain text
  • Ask questions with Docs AI

What would that look like?

Re the llm.txt file in the footer - no strong feelings. Only thought is, do we look 'hip and cool and with it' if we expose it? 😎

Copy link
Contributor

@aevesdocker aevesdocker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@sarahsanders-docker sarahsanders-docker merged commit a4eda2c into docker:main Apr 2, 2025
14 checks passed
@sarahsanders-docker sarahsanders-docker deleted the llms.txt branch April 21, 2025 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants