Skip to content

feat: add llms.txt and llms-full.txt - #42

Open
5ZYSZ3K wants to merge 1 commit into
mainfrom
feat/add-llms.txt
Open

feat: add llms.txt and llms-full.txt#42
5ZYSZ3K wants to merge 1 commit into
mainfrom
feat/add-llms.txt

Conversation

@5ZYSZ3K

Copy link
Copy Markdown
Collaborator

Add llms.txt and llms-full.txt to help llms learn the project

@5ZYSZ3K5ZYSZ3K self-assigned this Jun 5, 2026
@codecov

codecovBot commented Jun 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.65%. Comparing base (b829513) to head (e6fe5ea).

Additional details and impacted files
@@ Coverage Diff @@## main #42 +/- ##
=======================================
Coverage 98.65% 98.65% =======================================
Files 140 140 Lines 2085 2085 Branches 632 635 +3 =======================================
Hits 2057 2057 Misses 27 27 Partials 1 1 
FlagCoverage Δ
css-processor100.00% <ø> (ø)
render97.85% <ø> (ø)
transient-render-engine98.95% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@5ZYSZ3K
5ZYSZ3K requested a review from jsamrJune 6, 2026 15:23

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

How do we make sure this doesn't get out of sync? Isn't it new maintenance surface? I'm also not familiar with llms.txt, is this part of a standard?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

Yes, it is a standard now: https://llmstxt.org/
I basically followed, what next.js did: https://nextjs.org/llms.txt

However, now I see that in our case it wouldn't be accessible under https://native-html.github.io/llms.txt, but rather under https://native-html.github.io/render/llms.txt - I'll make sure that it will also work

Regarding keeping it in sync - I'll try to prepare a script, which would generate those files out of our documentation

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@5ZYSZ3K@jsamr