Skip to content

docs: rotate documentation for 2624 distribution #3320

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

Draft
jpraynaud wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: rotate documentation for 2624 distribution #3320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
336 changes: 20 additions & 316 deletions docs/website/openapi.current.yaml
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/website/root/manual/develop/references.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To learn more about the **Mithril protocol**, please refer to the [about Mithril
| **Mithril doc** | An API that generates markdown documentation for a crate command lines arguments. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/internal/mithril-doc) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_doc/index.html) | - | - |
| **Mithril doc derive** | A macro implementation used by **Mithril doc**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/internal/mithril-doc-derive) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_doc_derive/index.html) | - | - |
| **Mithril persistence** | The **persistence** library used by **Mithril network** nodes. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/internal/mithril-persistence) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_persistence/index.html) | - | - |
| **Cardano devnet** | The private **Cardano network** used to test a **Mithril network**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/blob/main/mithril-test-lab/cardano-devnet) | - | - | - |
| **Mithril end to end** | The tool used to run test scenarios against a **Mithril devnet**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/blob/main/mithril-explorer) | - | - | - |
| **Mithril explorer** | The explorer website that connects to a **Mithril aggregator** and displays its **certificate chain**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/blob/main/mithril-test-lab/mithril-end-to-end) | - | - | - |
| **Protocol simulation** | A simple CLI that helps understand how the **Mithril protocol** works and the role of its protocol parameters. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/blob/main/demo/protocol-demo) | - | - | - |
| **Cardano devnet** | The private **Cardano network** used to test a **Mithril network**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-test-lab/cardano-devnet) | - | - | - |
| **Mithril end to end** | The tool used to run test scenarios against a **Mithril devnet**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-explorer) | - | - | - |
| **Mithril explorer** | The explorer website that connects to a **Mithril aggregator** and displays its **certificate chain**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-test-lab/mithril-end-to-end) | - | - | - |
| **Protocol simulation** | A simple CLI that helps understand how the **Mithril protocol** works and the role of its protocol parameters. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/demo/protocol-demo) | - | - | - |
2 changes: 1 addition & 1 deletion docs/website/root/use-cases/bridges.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ A [WASM package](https://www.npmjs.com/package/@mithril-dev/mithril-client-wasm)
The core flow is straightforward:

1. Observe the lock or burn transaction on Cardano
2. Query the Mithril aggregator for a transaction proof of membership once the transation hash is known
2. Query the Mithril aggregator for a transaction proof of membership once the transaction hash is known
3. Verify the proof against the current Mithril certificate chain
4. Apply your finality criteria, then authorize the corresponding action on the destination chain.

Expand Down
2 changes: 1 addition & 1 deletion docs/website/versioned_docs/version-maintained/case-studies/daedalus.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ sidebar_label: "Case Study: Daedalus Wallet"

## The problem

Daedalus runs a full Cardano node locally. On first install, that node must sync the entire Cardano blockchain from genesis, replaying every block. Even on modern hardware, this takes many hours and significant bandwidth, historically a major friction point for users picking up a full-node wallet.
Daedalus runs a full Cardano node locally. On first install, that node must sync the entire Cardano blockchain from genesis, replaying every block. Even on modern hardware, this usually takes more than 24-36 hours, historically a major friction point for users picking up a full-node wallet.

## How Mithril helps

Expand Down
Loading
Loading