Skip to content

docs: add Blueprint codegen guide pagedocs: add Blueprint codegen guide page#163

Open
Laurel23 wants to merge 1 commit intoIntersectMBO:mainfrom
Laurel23:docs/blueprint-guide
Open

docs: add Blueprint codegen guide pagedocs: add Blueprint codegen guide page#163
Laurel23 wants to merge 1 commit intoIntersectMBO:mainfrom
Laurel23:docs/blueprint-guide

Conversation

@Laurel23
Copy link

Summary

This PR adds a dedicated guide page for the Blueprint module in the Evolution SDK.

Problem

Previously, the only available documentation for Blueprint was the auto-generated module reference. It lacked:

  • Workflow explanation
  • Codegen pipeline overview
  • CodegenConfig option details
  • Description of generated output
  • Practical usage examples

This made Blueprint difficult for new users to understand and use.

Solution

Added a new guide page blueprint-codegen.mdx that includes:

  • Step-by-step Blueprint workflow (Aiken → plutus.json → codegen → TypeScript bindings)
  • Example usage code snippets
  • Detailed CodegenConfig options table
  • Description of generated artifacts
  • Common pitfalls and tips

Impact

Improves developer onboarding and makes Blueprint one of the SDK’s primary entry points more accessible.

Closes #155

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.

docs: Blueprint codegen has no guide page — workflow, CodegenConfig options, and generated output are undocumented

1 participant