Add llms.txt generation from XML docs and update build#162
Merged
0xFirekeeper merged 1 commit intomainfrom Nov 7, 2025
Merged
Conversation
Introduces a new Makefile target 'generate-llms' to generate llms.txt from XML documentation using the generator project. Updates the build process to include llms.txt generation. Adds implementation in Thirdweb.Generator/Program.cs for parsing XML docs and outputting a formatted llms.txt file. Adds the initial generated llms.txt to the repository.
|
Caution Review failedThe pull request is closed. WalkthroughThis pull request adds a new build workflow to generate llms.txt from XML documentation. A Makefile target Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Makefile as Makefile<br/>(build)
participant DotNet as dotnet build
participant Makefile2 as Makefile<br/>(generate-llms)
participant Program as Program.cs<br/>--llms
participant XML as Thirdweb.xml
participant Output as llms.txt
User->>Makefile: make build
Makefile->>DotNet: dotnet build Release
DotNet->>DotNet: Compile
DotNet-->>Makefile: Success
Makefile->>Makefile2: Invoke generate-llms
Makefile2->>Program: Run with --llms flag
Program->>XML: Read Thirdweb.xml
XML-->>Program: XML content
Note over Program: Parse signatures<br/>Extract metadata<br/>Normalize types
Program->>Output: Write llms.txt
Output-->>Makefile2: Generated
Makefile2-->>Makefile: Success
Makefile-->>User: Build + Documentation complete
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (2)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Introduces a new Makefile target 'generate-llms' to generate llms.txt from XML documentation using the generator project. Updates the build process to include llms.txt generation. Adds implementation in Thirdweb.Generator/Program.cs for parsing XML docs and outputting a formatted llms.txt file. Adds the initial generated llms.txt to the repository.
PR-Codex overview
This PR introduces a new
generate-llmstarget in theMakefileand adds functionality to generatellms.txtfrom XML documentation in the C# project. It enhances the documentation generation process and improves the API client documentation.Detailed summary
generate-llmstarget inMakefilefor generatingllms.txt.GenerateLlmsTxtmethod to read XML documentation and createllms.txt.MemberSignatureandParameterInfoclasses to structure documentation data.Summary by CodeRabbit
New Features
Chores