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

ci: mdbook #2003

Merged
merged 8 commits into from
Jan 4, 2023
Merged

ci: mdbook #2003

merged 8 commits into from
Jan 4, 2023

Conversation

0xMelkor
Copy link
Contributor

@0xMelkor 0xMelkor commented Jan 3, 2023

Motivation

Provide a CI workflow for the book (continuation of #1994)

Solution

  • Update CI to publish the book on merge
  • Refine the summary and complete the docs
  • Embed code from the /examples folder

PR Checklist

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

@m0ham3dx
Copy link
Contributor

m0ham3dx commented Jan 3, 2023

There are these two interesting mdbook plugins which I would like to recommend

  1. mdbook-admonish: Callouts
  2. mdbook-mermaid: Enable Mermaid Diagrams

I have personally implemented both in my own work, I am writing this post instead of making a PR because I am slowly gaining familiarity with this whole CI thing, and not entirely sure if it might break your CI.

Here is an example of what the render looks like - HERE

@gakonst gakonst marked this pull request as ready for review January 4, 2023 10:36
@gakonst gakonst merged commit da03639 into gakonst:master Jan 4, 2023
@gakonst
Copy link
Owner

gakonst commented Jan 4, 2023

Merging so we get the first deploy of the book, and iterate from there.

@0xMelkor
Copy link
Contributor Author

0xMelkor commented Jan 4, 2023

CI failed to deploy the book

Failed to create deployment (status: 404) with build version da0363918b2157f405aed14e940dcf35970bce77. Ensure GitHub Pages has been enabled: https://github.com/gakonst/ethers-rs/settings/pages

@gakonst probably GitHub pages must be enabled. Otherwise I messed up something XD

@0xMelkor 0xMelkor deleted the ci-mdbook branch January 4, 2023 11:18
@gakonst
Copy link
Owner

gakonst commented Jan 4, 2023

fixed^^

Rjected pushed a commit to Rjected/ethers-rs that referenced this pull request Jan 4, 2023
* Applied same book structure as Reth

* ci: [WIP] added book workflow

* fix warning mdbook version different from template plugin version

* ci: added deploy step

* Http provider docs

* IPC provider docs

* RetryClient docs

* WebSocket provider docs

Co-authored-by: Andrea Simeoni <>
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.

3 participants