Skip to content

docs(www): add llms.txt files #4893

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(www): add llms.txt files #4893

wants to merge 1 commit into from

Conversation

jdegand
Copy link
Contributor

@jdegand jdegand commented Jul 21, 2025

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[X] Other... Please describe: AI context metadata

What is the current behavior?

There are no LLMS.txt files to help AI tools.

Partially #4804

What is the new behavior?

Expose LLMS.txt on new docs site.

The llms-full.txt file contains mostly all markdown content files from the www folder. I removed some architecture entries that have no real content. I used gitingest.com and removed the extra file headers it adds. The full file is very large. I removed some repeated stuff in the markdown files like the maintenance mode warning of the data package and the recommendation to use signals store. Things like recommendations are likely better suited to a cursor rules or something similar. I put the files in the public folder of the www folder. The NgRx docs doesn't have a public folder and I guess that stuff is getting removed so I decided to just add this to the new docs.

Does this PR introduce a breaking change?

[ ] Yes
[X] No

Other information

Copy link

netlify bot commented Jul 21, 2025

Deploy Preview for ngrx-io canceled.

Built without sensitive environment variables

Name Link
🔨 Latest commit 950a806
🔍 Latest deploy log https://app.netlify.com/projects/ngrx-io/deploys/687d939fbe0e9b0008bcf28b

Copy link

netlify bot commented Jul 21, 2025

Deploy Preview for ngrx-site-v19 ready!

Name Link
🔨 Latest commit 950a806
🔍 Latest deploy log https://app.netlify.com/projects/ngrx-site-v19/deploys/687d939f9787090008ea4b62
😎 Deploy Preview https://deploy-preview-4893--ngrx-site-v19.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 project configuration.

Copy link
Member

@timdeschryver timdeschryver left a comment

Choose a reason for hiding this comment

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

@markgoho is this what you had in mind?
@jdegand if possible, it would be a nice to have to also automate this task. Do you think that's possible?

@jdegand
Copy link
Contributor Author

jdegand commented Jul 22, 2025

@timdeschryver There is a website called firecrawl that provides an endpoint to get llms files. Potentially, you could setup a monthly API request to get a new file. Also, you would need to vet security of using this.

Looking at GitHub action solutions:

name: Merge Markdown Files

on:
  push:
    branches: [main]
    paths:
      - 'projects/www/src/app/pages/guide/**/*.md'

jobs:
  merge:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install merge-markdown
        run: npm install -g @knennigtri/merge-markdown
      - name: Merge files
        run: merge-markdown -i projects/www/src/app/pages/guide/*.md -o projects/www/public/llms-full.txt

  • markdown-autodocs
    • This seems more suited to getting specific sections of files versus the full file.

Note: the workflow code needs to be slightly tweaked to commit newly created file back to the main branch.

@jdegand
Copy link
Contributor Author

jdegand commented Jul 22, 2025

I should mention that using the markdown itself in the llms-full.txt file shouldn't trip up the AI (having app-code-example inside the txt file versus backticks with ts).

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.

2 participants