Coder Social home page Coder Social logo

RFCs Web Page [mdbook] about rfcs HOT 7 CLOSED

polkadot-fellows avatar polkadot-fellows commented on July 21, 2024 4
RFCs Web Page [mdbook]

from rfcs.

Comments (7)

xlc avatar xlc commented on July 21, 2024 3

I can't say I enjoy the font and colour scheme (mostly the slime green) but otherwise looks good
Screenshot 2023-12-04 at 1 08 58 PM

from rfcs.

rzadp avatar rzadp commented on July 21, 2024 3

Thanks for the feedback. :)

Update

  • I have toned down the Polkadot branded theme.
  • I'm generating TOCs.
  • I've separated proposed RFCs into "new", "stale", and the rest
    • Currently "new" means PRs created in the last 7 days, and "stale" means PRs not updated for at least 30 days.

Please take another look.

from rfcs.

rzadp avatar rzadp commented on July 21, 2024 2

We also should start think about categories or tags. A good place to add category and tags can be the header https://github.com/polkadot-fellows/RFCs/blob/main/0000-template.md

@davxy The problem with categories/tags in the header is that it cannot be applied for the RFCs that are already merged - the exact hash of the text is on-chain so the text shouldn't be changed after merging.

And even if we're only looking at new RFCs, the problem will be that we won't be able to re-categorize / re-tag them in the future (for the same reason).

How about using github labels for this purpose? Already-merged PRs can be re-labeled.

from rfcs.

davxy avatar davxy commented on July 21, 2024 1

Some personal opinions:

  • I prefer a simple monospaced font and with less colors around. Something more close to the IETF RFCs (EIP are quite good).
  • Is possible to auto generate a TOC at the begin for easy navigation? Should be. We can limit TOC depth to maybe 1 or 2 or even 3 (but not 4)
  • A table like this would be nice for exploration. We also should start think about categories or tags. A good place to add category and tags can be the header https://github.com/polkadot-fellows/RFCs/blob/main/0000-template.md

from rfcs.

rzadp avatar rzadp commented on July 21, 2024

I have created the mdbook and I'm looking for feedback.

The book can be previewed here.

Calling thumb-uppers: @xlc @lrazovic @davxy @bkchr

from rfcs.

shawntabrizi avatar shawntabrizi commented on July 21, 2024

I agree, I don't think there is any need for aggressive styling.

from rfcs.

lrazovic avatar lrazovic commented on July 21, 2024

Very well done!

I agree with the feedback provided earlier. I appreciate the concept of a 'Polkadot' theme aligned with the brand identity (https://polkadot.network/ecosystem/brand-hub/), but considering the nature of the site's content, perhaps prioritizing readability in the default theme would be more beneficial. The 'Polkadot' theme could then be offered as an alternative option.

from rfcs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.