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
+27 −2
Open

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

Show file tree
Hide file tree
Changes from all commits
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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,24 @@ Integration of the [`ledger`](https://github.com/IntersectMBO/cardano-ledger), [

See the [Contributing guide](CONTRIBUTING.md) for how to contribute to this project.

## Development Setup
Copy link
Contributor

@carbolymer carbolymer Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should go to CONTRIBUTING.md.


### Using Claude Code

For developers using [Claude Code](https://claude.ai/code), project-specific configuration can be set up by:

1. Clone the omni-dev-config repository:
```bash
git clone https://github.com/input-output-hk/omni-dev-config
```

2. Symlink `CLAUDE.md` from omni-dev-config to this repository:
```bash
ln -s /path/to/omni-dev-config/CLAUDE.md /path/to/cardano-api/CLAUDE.md
```

This provides Claude Code with project-specific context, coding standards, and best practices.

## Core maintainers

* [Jordan Millar](https://github.com/Jimbo4350)
Expand All @@ -17,6 +35,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
2 changes: 1 addition & 1 deletion cardano-api-gen/cardano-api-gen.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ category:
API,
Test,

copyright: 2020-2024 Input Output Global Inc (IOG).
copyright: 2020-2025 Input Output Global Inc (IOG).
author: IOHK
maintainer: [email protected]
license: Apache-2.0
Expand Down
2 changes: 1 addition & 1 deletion cardano-api/cardano-api.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ category:
Cardano,
API,

copyright: 2020-2024 Input Output Global Inc (IOG).
copyright: 2020-2025 Input Output Global Inc (IOG).
author: IOHK
maintainer: [email protected]
license: Apache-2.0
Expand Down
1 change: 1 addition & 0 deletions cardano-api/src/Cardano/Api.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ module Cardano.Api
, module Cardano.Api.Monad.Error
, module Cardano.Api.Pretty
, module Cardano.Api.IO
, module Cardano.Api.HasTypeProxy
)
where

Expand Down
Loading