docs: improve documentation and re-export HasTypeProxy module #990
Conversation
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
Adds HasTypeProxy to the main Cardano.Api module exports to provide direct access to type proxy functionality without requiring separate imports.
Enhances the main README with direct links to individual package documentation for easier navigation and discovery. - Add links to cardano-api main library documentation - Add links to cardano-api-gen test utilities documentation - Add links to cardano-rpc gRPC protocol documentation - Add links to cardano-wasm WebAssembly support documentation
Provides instructions for setting up project-specific Claude Code configuration using the omni-dev-config repository. - Document steps to clone omni-dev-config repository - Explain how to symlink CLAUDE.md for project context - Clarify benefits of Claude Code integration
newhoggy
requested review from
CarlosLopezDeLara,
Jimbo4350,
carbolymer,
dcoutts,
disassembler,
erikd,
kevinhammond and
palas
as code owners
carbolymer
approved these changes
Oct 29, 2025
carbolymer
requested changes
Oct 30, 2025
|
|
||
| See the [Contributing guide](CONTRIBUTING.md) for how to contribute to this project. | ||
|
|
||
| ## Development Setup |
Contributor
There was a problem hiding this comment.
This should go to CONTRIBUTING.md.
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.
Changelog
Context
This PR enhances the developer experience by improving documentation and API accessibility. The changes address three main areas:
API Improvement: Re-exports the
HasTypeProxymodule directly fromCardano.Api, eliminating the need for separate imports when using type proxy functionality.Documentation Enhancement: Adds clear navigation links to package-specific documentation and introduces setup instructions for Claude Code development environment integration.
Maintenance: Updates copyright years across package cabal files.
How to trust this PR
Module Re-export Verification:
HasTypeProxymodule is now accessible viaimport Cardano.ApiCardano.Api.HasTypeProxyseparately will continue to workDocumentation Updates:
Copyright Updates:
Checklist