feat: generate llm docs #565
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added a script to generate LLM-friendly documentation files for the SDK. This creates three files in the docs directory:
llms.txt
- Configuration for LLM bots with userAgent and include/disallow rulessdk-summary.txt
- Overview of the SDK packages with key exports from coresdk-react-summary.txt
- List of React hooks exported from the React packageThe script automatically extracts exports from the core and React packages to keep the documentation up-to-date with the codebase.
What to review
scripts/generate-llms-docs.mts
for extracting exportsTesting
Tested by running the script manually and verifying the generated files contain accurate information about the SDK exports. The script includes error handling and fallbacks if files aren't found.
Fun gif