Skip to content

docs: improve documentation and re-export HasTypeProxy module #990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

docs: improve documentation and re-export HasTypeProxy module #990

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7414ca
feat(api): re-export HasTypeProxy module
newhoggy Oct 29, 2025
f7c3e86
docs: add package-specific documentation links
newhoggy Oct 29, 2025
5dac24d
docs: add Claude Code development setup instructions
newhoggy Oct 29, 2025
020d228
chore: update copyright year to 2025
newhoggy Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: add package-specific documentation links 
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
  • Loading branch information
@newhoggy
newhoggy committed Oct 29, 2025
commit f7c3e863f474f67b62ac76296cf56a16f5aca39b
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ See the [Contributing guide](CONTRIBUTING.md) for how to contribute to this proj

## Documentation

Package-specific documentation:
- [cardano-api](cardano-api/README.md) - Main library for constructing and submitting transactions
- [cardano-api-gen](cardano-api-gen/README.md) - Test generators and property testing utilities
- [cardano-rpc](cardano-rpc/README.md) - gRPC client and server implementing UTxO RPC protocol
- [cardano-wasm](cardano-wasm/README.md) - WebAssembly compilation support

Development documentation can be found in [Cardano Node Wiki](https://github.com/input-output-hk/cardano-node-wiki/wiki).

Haddock documentation is available at: https://cardano-api.cardano.intersectmbo.org/
Expand Down