IntersectMBO / IntersectMBO/cardano-base

Add comprehensive documentation for all cardano-base packages

Open
#564 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Haskell
Stars
105
Forks
54
Avg merge
9d 2h
Merged PRs (30d)
4

Description

Add developer-focused documentation with working examples for all packages in cardano-base.

## Changes
- **Enhanced existing docs** : README.md, cardano-binary, cardano-crypto-class, cardano-crypto-praos
- **Added new READMEs** : base-deriving-via, cardano-slotting, cardano-strict-containers, heapwords, measures, orphans-deriving-via

## What's Included
- Working code examples for each package
- Clear API usage patterns
- Integration guides between packages
- Developer onboarding path

## Benefits
- Lowers barrier to entry for new developers
- Provides missing documentation for previously undocumented packages
- Consistent structure across all packages
- Production-ready examples with error handling

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.