Skip to content

feat: create llms.txt generator #254

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 15 commits into from
May 3, 2025
Merged

Conversation

araujogui
Copy link
Member

Description

Creates a llms.txt generator

Validation

npx api-docs-tooling generate  -i doc/api/*.md -t llms-txt -o out/

Related Issues

Fixes #226

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I've covered new added functionality with unit tests if necessary.

@araujogui araujogui requested a review from a team as a code owner April 29, 2025 13:29
@AugustinMauroy
Copy link
Member

Could you add some test this is not a legacy thing.

Copy link
Member

@AugustinMauroy AugustinMauroy left a comment

Choose a reason for hiding this comment

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

LGMT ! that's cool

@araujogui
Copy link
Member Author

araujogui commented Apr 30, 2025

I'm not sure using the first paragraph node as the description is a good idea. Here's the actual llms.txt—some of the descriptions seem incorrect: https://pastebin.com/edEGgFLy

Maybe we could add another yaml property like llm-description to api docs

Copy link
Member

@ovflowd ovflowd left a comment

Choose a reason for hiding this comment

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

Minor nits but LGTM!

Copy link
Member

@ovflowd ovflowd left a comment

Choose a reason for hiding this comment

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

Final review pass! (There's 2 open threads, feel free to resolve them when you're ready and merge the PR)

@araujogui araujogui merged commit 1a08176 into nodejs:main May 3, 2025
6 checks passed
Sign up for free to 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.

Generate llms.txt
4 participants