Skip to content
This repository has been archived by the owner on Oct 19, 2024. It is now read-only.

docs: mdbook #1994

Merged
merged 9 commits into from
Jan 3, 2023
Merged

docs: mdbook #1994

merged 9 commits into from
Jan 3, 2023

Conversation

0xMelkor
Copy link
Contributor

@0xMelkor 0xMelkor commented Dec 31, 2022

Motivation

We want to provide a hands-on book for ethers-rs users. This PR is a continuation of #1940.

Solution

  • Create a mdbook into docs/mdbook

Let me know if you wish to refine this any further. Any contribs are welcome.

Thank you guys.

PR Checklist

  • Added Tests
  • Added Documentation
  • Updated the changelog
  • Breaking changes

docs/mdbook/book.toml Outdated Show resolved Hide resolved
@gakonst gakonst marked this pull request as ready for review January 3, 2023 13:18
@gakonst gakonst merged commit 04ed534 into gakonst:master Jan 3, 2023
@gakonst
Copy link
Owner

gakonst commented Jan 3, 2023

LGTM - merged as-is. Supportive of the next steps you outlined above.

Let's pull up book.toml to live in project root, similar to how https://github.com/paradigmxyz/reth/tree/main/book is set up.

https://github.com/paradigmxyz/reth/blob/main/book.toml

CI:
https://github.com/paradigmxyz/reth/blob/main/.github/workflows/book.yml

@0xMelkor 0xMelkor deleted the docs-book branch January 3, 2023 13:55
@0xMelkor 0xMelkor mentioned this pull request Jan 3, 2023
7 tasks
Rjected pushed a commit to Rjected/ethers-rs that referenced this pull request Jan 4, 2023
* mdbook init + summary

* Getting started section

* intro typos

* intro typos and wording

* intro typos and wording

* Big numbers section

* Big numbers: added section titles + docs refinement

* Removed index prefix from file names

* Update docs/mdbook/book.toml

Co-authored-by: Andrea Simeoni <>
Co-authored-by: Georgios Konstantopoulos <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants