Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 20, 2025

  • Remove custom GitHub Action workflow for llms.txt generation
  • Remove custom script for generating llms.txt
  • Install docusaurus-plugin-llms package
  • Configure plugin in docusaurus.config.ts
  • Verify plugin generates llms.txt and llms-full.txt files
  • Resolve merge conflicts with main branch (multiple times)

Implementation Complete ✅

Successfully integrated the docusaurus-plugin-llms plugin and kept the branch up to date with main.

Merge Conflict Resolution

Resolved conflicts in:

  • website/package.json: Updated to latest dependency versions from main while keeping docusaurus-plugin-llms addition
    • @types/node: Updated from ^22.18.6 to ^24.9.2
    • @types/react: Updated from ^19.1.13 to ^19.2.2
    • Kept docusaurus-plugin-llms: ^0.2.2
  • pnpm-lock.yaml: Regenerated with updated dependencies

Multiple clean merges from main to keep the branch up to date with latest changes including new GitHub workflows and Copilot instructions.

Plugin Configuration

The plugin is configured in website/docusaurus.config.ts:

[
  'docusaurus-plugin-llms',
  {
    generateLLMsTxt: true,
    generateLLMsFullTxt: true,
    title: 'fast-check Documentation',
    description: 'Complete documentation for fast-check - Property-based testing framework for JavaScript/TypeScript',
    includeBlog: true,
    excludeImports: true,
    removeDuplicateHeadings: true,
    generateMarkdownFiles: true,
  },
]

Generated Files

The plugin automatically generates during build:

  • llms.txt (19KB) - Table of contents with links to all 110+ documentation sections
  • llms-full.txt (555KB) - Complete documentation content in a single file
  • Individual markdown files for each documentation section

All files follow the llmstxt.org standard and will be served at https://fast-check.dev/llms.txt and https://fast-check.dev/llms-full.txt when deployed.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@changeset-bot
Copy link

changeset-bot bot commented Sep 20, 2025

⚠️ No Changeset found

Latest commit: bc3b9a8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copilot AI changed the title [WIP] Provide me with a way to generate a llms.txt file readable by ai bots on my website. Something I can trigger via an action that will then create a pr for the doc Add GitHub Action to generate llms.txt for AI bots and crawlers Sep 20, 2025
Copilot AI requested a review from dubzzz September 20, 2025 08:00
Copilot finished work on behalf of dubzzz September 20, 2025 08:00
@dubzzz
Copy link
Owner

dubzzz commented Sep 20, 2025

@copilot please make the content dynamic

Copy link
Contributor Author

Copilot AI commented Sep 20, 2025

@copilot please make the content dynamic

Made the content dynamic! The script now extracts information from package.json, README.md, and git tags to generate up-to-date llms.txt content. It includes current version (4.3.0), actual package description, keywords, dependencies, funding links, and author information dynamically. Commit: 2a51e4b

Copilot AI changed the title Add GitHub Action to generate llms.txt for AI bots and crawlers Add GitHub Action to generate dynamic llms.txt for AI bots and crawlers Sep 20, 2025
Copilot finished work on behalf of dubzzz September 20, 2025 08:09
@dubzzz
Copy link
Owner

dubzzz commented Nov 1, 2025

@copilot restart from scratch, connect this library instead https://github.com/rachfop/docusaurus-plugin-llms

Copy link
Contributor Author

Copilot AI commented Nov 1, 2025

@copilot restart from scratch, connect this library instead https://github.com/rachfop/docusaurus-plugin-llms

Done! Replaced the custom implementation with the docusaurus-plugin-llms plugin. The plugin now automatically generates both llms.txt (19KB with links to all sections) and llms-full.txt (555KB with full content) during the build process. No GitHub Action workflow needed - it's all integrated into the Docusaurus build. Commit: 521b8f4

Generated files:

  • llms.txt: Table of contents with links following llmstxt.org standard
  • llms-full.txt: Complete documentation in one file (110 pages processed)

Copilot AI changed the title Add GitHub Action to generate dynamic llms.txt for AI bots and crawlers Add docusaurus-plugin-llms to generate llms.txt for AI bots and crawlers Nov 1, 2025
Copilot finished work on behalf of dubzzz November 1, 2025 07:50
@dubzzz dubzzz marked this pull request as ready for review November 1, 2025 08:44
@dubzzz
Copy link
Owner

dubzzz commented Nov 1, 2025

@copilot fix merge conflicts

- Updated dependency versions from main
- Kept docusaurus-plugin-llms addition
- Regenerated pnpm-lock.yaml
Copy link
Contributor Author

Copilot AI commented Nov 1, 2025

@copilot fix merge conflicts

Fixed! Resolved merge conflicts in website/package.json and pnpm-lock.yaml. Updated dependency versions from main (@types/node: ^24.9.2, @types/react: ^19.2.2) while keeping the docusaurus-plugin-llms addition. Regenerated lockfile. Commit: 6c88366

@socket-security
Copy link

socket-security bot commented Nov 1, 2025

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addeddocusaurus-plugin-llms@​0.2.28310010088100

View full report

Copilot AI requested a review from dubzzz November 1, 2025 08:54
Copilot finished work on behalf of dubzzz November 1, 2025 08:54
@github-actions
Copy link
Contributor

github-actions bot commented Nov 1, 2025

👋 A preview of the new documentation is available at: http://6905cd64a0cf68b10bf45653--dubzzz-fast-check.netlify.app

@pkg-pr-new
Copy link

pkg-pr-new bot commented Nov 1, 2025

@fast-check/examples

@fast-check/ava

npm i https://pkg.pr.new/@fast-check/ava@6180

@fast-check/expect-type

npm i https://pkg.pr.new/@fast-check/expect-type@6180

fast-check

npm i https://pkg.pr.new/fast-check@6180

@fast-check/jest

npm i https://pkg.pr.new/@fast-check/jest@6180

@fast-check/packaged

npm i https://pkg.pr.new/@fast-check/packaged@6180

@fast-check/poisoning

npm i https://pkg.pr.new/@fast-check/poisoning@6180

@fast-check/vitest

npm i https://pkg.pr.new/@fast-check/vitest@6180

@fast-check/worker

npm i https://pkg.pr.new/@fast-check/worker@6180

commit: bc3b9a8

@codecov
Copy link

codecov bot commented Nov 1, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.98%. Comparing base (ad5a9c3) to head (bc3b9a8).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6180   +/-   ##
=======================================
  Coverage   95.98%   95.98%           
=======================================
  Files         212      212           
  Lines       10194    10194           
  Branches     2765     2765           
=======================================
  Hits         9785     9785           
  Misses        409      409           
Flag Coverage Δ
tests 95.98% <ø> (ø)
tests-against-22.x-on-macOS 95.98% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 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.

@dubzzz dubzzz changed the title Add docusaurus-plugin-llms to generate llms.txt for AI bots and crawlers 📝 Generate llms.txt and related for AI crawlers Nov 1, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 1, 2025

👋 A preview of the new documentation is available at: http://690656710ef96afb1c25ca6d--dubzzz-fast-check.netlify.app

  Applied by GitHub Action workflow: PR Format
  Run ID: 19001249160
  Target PR: 6180
@dubzzz
Copy link
Owner

dubzzz commented Nov 1, 2025

@copilot fix merge conflicts

- Added GitHub Copilot instructions
- Renamed format-pr workflow to pr-format
- Added pr-pnpm-conflicts workflow
Copy link
Contributor Author

Copilot AI commented Nov 1, 2025

@copilot fix merge conflicts

Fixed! Merged latest changes from main branch. No conflicts were encountered - the merge completed cleanly. Added new GitHub Copilot instructions, renamed format workflow, and added pnpm conflicts workflow. Commit: bc3b9a8

Copilot AI requested a review from dubzzz November 1, 2025 21:10
Copilot finished work on behalf of dubzzz November 1, 2025 21:10
@dubzzz dubzzz enabled auto-merge (squash) November 1, 2025 21:11
@dubzzz dubzzz disabled auto-merge November 1, 2025 21:13
@dubzzz dubzzz enabled auto-merge (squash) November 1, 2025 21:13
@github-actions
Copy link
Contributor

github-actions bot commented Nov 1, 2025

👋 A preview of the new documentation is available at: http://6906786565a79639cd53473b--dubzzz-fast-check.netlify.app

@dubzzz dubzzz merged commit 8419a84 into main Nov 1, 2025
37 of 133 checks passed
@dubzzz dubzzz deleted the copilot/fix-1b52d3a9-9fd5-4f41-a1a7-9502a23ca141 branch November 1, 2025 21:20
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