Skip to content
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.

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

[EngAut] RFCs Web Page #1

Closed
mordamax opened this issue Nov 23, 2023 · 3 comments
Closed

[EngAut] RFCs Web Page #1

mordamax opened this issue Nov 23, 2023 · 3 comments
Assignees

Comments

@mordamax
Copy link
Collaborator

@PierreBesson suggested rendering our polkadot-fellows/RFCs as a webpage - similar to https://eips.ethereum.org/

Could be made by markdown book https://rust-lang.github.io/mdBook/index.html
Must be integrated into RFC's repo https://github.com/polkadot-fellows/RFCs/

@mordamax mordamax moved this from Draft to Open in Parity Roadmap Nov 23, 2023
@rzadp
Copy link

rzadp commented Nov 23, 2023

Hey, I've done some initial work on this. cc @paritytech/opstooling

I created a separate repo: https://github.com/paritytech/rfc-book

Here is the current output: https://paritytech.github.io/rfc-book/

How it works

It downloads the contents of the RFCs repo (approved RFCs), downloads the contents of all pending PRs (proposed RFCs), and constructs an mdbook out of it.
The book is published to gh-pages.

It's not finished but I'm sending it here for preview early. Important thing I know it's missing is a link to source (e.g. looking at a proposed RFCs, I would want to have a link to the PR it comes from in case I want to make a comment there).

My questions

Must be integrated into RFC's repo

Does it really need to be integrated into that repo, or could it be a separate repo in polkadot-fellows?

For one, I wouldn't want to mix ugly bash PRs with RFC text PRs.
Second, (if I'm right) we won't rely on commits on main, but we will do the cron-based updates (because we can't feasibly track all the commits on all the PRs, which also come from forks) - so we don't have to hook into events from that repo.

@rzadp
Copy link

rzadp commented Nov 29, 2023

A new preview is available here.

The updated code can be reviewed here

@mordamax
Copy link
Collaborator Author

mordamax commented Jan 2, 2024

Closes with polkadot-fellows/RFCs#60

@mordamax mordamax closed this as completed Jan 2, 2024
@github-project-automation github-project-automation bot moved this from Open to Closed in Parity Roadmap Jan 2, 2024
@mordamax mordamax changed the title [EngAug] RFCs Web Page [EngAut] RFCs Web Page Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants