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

Jump to bottom

Documentation before release #165

Open

gjermundgaraba opened this issue Dec 10, 2024 · 0 comments

Labels

documentation epic

Contributor

gjermundgaraba commented Dec 10, 2024

Tracking issue for documentation work needed.

We need to make all components well documented so that they can be easily understood and used.

We need to cover:

Purpose and intended use case
High level architectural diagram with Mermaid
How to build and test
How to integrate/use

Components that need a README.md

programs/sp1-programs/README.md
programs/cw-ics08-wasm-eth/README.md
programs/relayer/README.md
contracts/README.md

The text was updated successfully, but these errors were encountered:

gjermundgaraba added documentation epic labels

gjermundgaraba added this to IBC-GO Eureka

github-project-automation bot moved this to Backlog in IBC-GO Eureka

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment