pezkuwi-fellows/mdbook/README.md at dde721f16f9d6e3387e2b7fca9d8a64007d7ac9b - pezkuwi-fellows - PezkuwiChain Git

pezkuwichain/pezkuwi-fellows

mirror of https://github.com/pezkuwichain/pezkuwi-fellows.git synced 2026-04-22 13:47:58 +00:00

Files

T

Przemek Rzad f94ab697e5 Introduce RFC mdBook web page (#60 )

- Closes https://github.com/polkadot-fellows/RFCs/issues/53
- Preview available [here](https://paritytech.github.io/RFCs/).

![Screenshot 2023-12-19 at 13 55
05](https://github.com/polkadot-fellows/RFCs/assets/12039224/ee06a7ad-231e-4077-a773-c6319661dfb6)


---

### What it does

- The workflow gathers the source markdown files of RFCs - approved
ones, and proposed ones (from open PRs).
- The proposed RFCs are separated into new (<7 days since PR created)
and stale (>30 days since PR updated).
- The RFCs are extended with a table of contents, and a link to the
source.
- The RFCs are build into a web page using
[mdBook](https://github.com/rust-lang/mdBook).
- The built web page gets pushed to `gh-pages` branch - to be published
in Github Pages.
- The workflow is triggered on merge to `main`, and periodically once a
day.

2024-01-03 20:05:00 +01:00

9 lines

201 B

Markdown

Raw Blame History

 # RFCs book
 An mdbook-based web page for presenting approved and proposed RFCs.
 ## Prerequisites
 - [mdbook](https://github.com/rust-lang/mdBook)
 - [mdbook-toc](https://github.com/badboy/mdbook-toc)