Skip to content

Llms txt#8

Merged
abrulic merged 11 commits intogenerate-documentationfrom
llms-txt
Sep 3, 2025
Merged

Llms txt#8
abrulic merged 11 commits intogenerate-documentationfrom
llms-txt

Conversation

@abrulic
Copy link
Copy Markdown
Collaborator

@abrulic abrulic commented Sep 1, 2025

Fixes #3

Note

Base branch is generate-documentation

Screenshots

From test repository docs-template-example
image

image

From this repository docs-template
image

@abrulic abrulic changed the base branch from main to generate-documentation September 1, 2025 14:13
@github-actions
Copy link
Copy Markdown

github-actions bot commented Sep 1, 2025

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 95.66% 331 / 346
🔵 Statements 95.66% 331 / 346
🔵 Functions 78.57% 33 / 42
🔵 Branches 98.94% 94 / 95
File CoverageNo changed files found.
Generated in workflow #34 for commit efedf80 by the Vitest Coverage Report Action

@abrulic abrulic marked this pull request as ready for review September 1, 2025 14:38
@thomasfr
Copy link
Copy Markdown

thomasfr commented Sep 1, 2025

Very cool! Format looks good.
How would that work with different versions? Wouldn't it be better to generate this text file during the build of and for the specific version, so that you have both text files available for each generated doc version?

@abrulic
Copy link
Copy Markdown
Collaborator Author

abrulic commented Sep 1, 2025

Very cool! Format looks good. How would that work with different versions? Wouldn't it be better to generate this text file during the build of and for the specific version, so that you have both text files available for each generated doc version?

Do you mean that I should get the version from the URL so that we have e.g domain.com/v3.0.0/llms.txt?

@thomasfr
Copy link
Copy Markdown

thomasfr commented Sep 1, 2025

Very cool! Format looks good. How would that work with different versions? Wouldn't it be better to generate this text file during the build of and for the specific version, so that you have both text files available for each generated doc version?

Do you mean that I should get the version from the URL so that we have e.g domain.com/v3.0.0/llms.txt?

Yeah, i think every version should have its own and maybe the root /llms.txt should then point to the latest version. What do you think?

@abrulic
Copy link
Copy Markdown
Collaborator Author

abrulic commented Sep 1, 2025

Very cool! Format looks good. How would that work with different versions? Wouldn't it be better to generate this text file during the build of and for the specific version, so that you have both text files available for each generated doc version?

Do you mean that I should get the version from the URL so that we have e.g domain.com/v3.0.0/llms.txt?

Yeah, i think every version should have its own and maybe the root /llms.txt should then point to the latest version. What do you think?

Thanks, great idea. Updated.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

version vs versions in different file names. Correct would be version-utils but why append utils if its already in an util folder?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

fixed

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Why append utils if its already in an utils folder

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

fixed

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nope its not fixed

@abrulic abrulic requested a review from thomasfr September 3, 2025 14:08
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nope its not fixed

@abrulic abrulic requested a review from thomasfr September 3, 2025 14:25
@abrulic abrulic merged commit b06fb7b into generate-documentation Sep 3, 2025
@abrulic abrulic deleted the llms-txt branch September 24, 2025 09:45
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.

create llms.txt

2 participants