initial workflow for AI generated drafts#574
Merged
smk762 merged 4 commits intokdf/auto-issuesfrom Nov 10, 2025
Merged
Conversation
Documentation Preview LinksPreview for commit: c48c7e3 Changed Documentation FilesCommit: c48c7e3 - adds generated method docCommit: c48c7e3 - adds generated method doc |
…orkflow
- Add AI_AGENT_REFERENCE_GUIDE.md explaining auto-generation principles
- Update auto-PR scripts to follow proper build process
- Ensure auto-generated files (index.mdx, filepathSlugs.json) are not committed
- Add build validation to workflow
- Include detailed documentation structure requirements
- Add proper {{label}} attribute requirements for script parsing
Major improvements to the auto-documentation generation process:
SYNC SCRIPT ENHANCEMENTS:
• Extract JSON code blocks from PR descriptions automatically
• Parse request parameters and types from real examples
• Derive method information from actual implementation code
• Generate structured issue content with parameter details
• Handle template variables ({{userpass}}) in JSON examples
AUTO-PR SCRIPT ENHANCEMENTS:
• Parse structured method information from enhanced issues
• Use real parameter examples in generated documentation
• Include extracted parameter details in documentation
• Generate realistic request examples from source PR data
• Improved template with actual method descriptions
WORKFLOW IMPROVEMENTS:
• End-to-end validation with build test integration
• Proper {{label}} attribute handling for script parsing
• CompactTable component integration for API documentation
• Enhanced AI prompts with structured information context
EXAMPLE WITH PR #2587:
• Automatically extracts consolidate_utxos method details
• Parses coin and merge_conditions parameters with types
• Generates documentation with real JSON examples
• Includes parameter structure: merge_at (integer), max_merge_at_once (integer)
This addresses the need to capture actual code examples from PRs like
komodo-defi-framework#2587 and use them to generate accurate API documentation
instead of generic templates.
Contributor
Author
|
This PR includes as generated method doc for GLEECBTC/komodo-defi-framework#2587 / #573 It's not perfect, but should pass CI tests 🤞 I'll fix it up manually here, but more work is needed on the prompt to ensure usage of components (Notes, CompactTable, Codegroup) and adherence to structure / styles. UPDATE: Enhancements delegated to issue at #592 |
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
1 participant
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.
This is mostly a placeholder. Once the
auto-issuesand thisauto-draft-prare merged into dev, we can refine both workflows to work well in harmony, and implement agreed upon KDF repo PR requirements to ensure the AI used in these workflows produces quality output.Note: Further work on auto-pr-draft workflow should also await the merge of a few other pending PRs:
These new components introduce a modularisation which will make it simpler for the AI to populate drafts.