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

Website: Human-friendly preamble #6017

Merged
merged 78 commits into from
Jan 25, 2023

Conversation

Pandapip1
Copy link
Member

@Pandapip1 Pandapip1 commented Nov 21, 2022

Turns this:

Click to expand

Into this:

Click to expand

Test it out yourself (it looks better in context than in screenshots): https://pandapip1.github.io/EIPs/

@eth-bot
Copy link
Collaborator

eth-bot commented Nov 21, 2022

A critical exception has occurred:
Message: pr 6017 is already merged; quitting
(cc @alita-moore, @mryalamanchi)

@Pandapip1 Pandapip1 marked this pull request as ready for review November 21, 2022 18:09
@Pandapip1 Pandapip1 requested a review from eth-bot as a code owner November 21, 2022 18:09
@xinbenlv
Copy link
Contributor

One data point: I kind of like the table view slightly better...

@SamWilsn
Copy link
Contributor

I'm not opposed generally to changing the layout, but I think the template currently in this PR makes it harder to scan for relevant information.

What about something like this:

Untitled

Ignore the fonts, font sizes, and colors 🤣

Notable changes:

  • Always display discussion link.
  • Separate author name from link so that I don't accidentally open my mail client.
  • Use color to highlight / separate the category/status/track.

@Pandapip1
Copy link
Member Author

Good idea, but that'll be quite a bit more work. I'll move it to draft in the meantime.

@Pandapip1 Pandapip1 marked this pull request as draft November 22, 2022 19:24
@SamWilsn
Copy link
Contributor

image

Not sure if you're done with these yet, but the bottom of the images should line up with the text baseline (and not the bottom of the bounding box.) The comment bubble link is an excellent idea though!

@Pandapip1
Copy link
Member Author

the bottom of the images should line up with the text baseline

If you have any idea how to do this, your help would be appreciated. But it really really doesn't want to work.

@Pandapip1 Pandapip1 requested a review from SamWilsn December 27, 2022 14:41
@SamWilsn
Copy link
Contributor

SamWilsn commented Jan 2, 2023

Something like:

a {
  height: 1ex;
  display: inline-block;
  vertical-align: baseline;
}

.inline-svg {
  width: 100%;
  height: 100%;
  object-fit: cover;
}

Probably want to use a class for the a block's selector though.

@Pandapip1
Copy link
Member Author

Fixed.

_layouts/eip.html Outdated Show resolved Hide resolved
assets/css/style.scss Outdated Show resolved Hide resolved
@eth-bot eth-bot enabled auto-merge (squash) January 25, 2023 20:59
@eth-bot eth-bot merged commit b216982 into ethereum:master Jan 25, 2023
iseriohn pushed a commit to iseriohn/EIP-NFT-Rights-Management that referenced this pull request Feb 16, 2023
* Website: Human-friendly preamble

* Fix syntax error

* Fix more syntax errors

* Indicate authors a little better

* Fix small typo

* Fix another syntax error

* Make use of blockquotes for withdraw reason

* Remove redunant/removed items

* Add additional linebreak

* Include bootstrap CSS

* Move to correct folder

* Add responsive meta tag

* Badges fade on hover

* Commit changes so far

* Temporarily delete integrities while in development

* Delete custom-head.html

* Update eip.html

* Update eip.html

* Update style.scss

* Remove bootstrap references

* Use remove theme that adds markdown

* Use regular minima again

* Add bootstrap styling

* Remove MathJax and bootstrap from eips rendering

* ... and place it in the head

* Fix typos

* Make header work with bootstrap

* Add category badges

* Update styles

* Fix integrities

* Upgrade to mathjax v3

* Update style.scss

* Use correct mathjax integrity

* Change badge color scheme

* Move badges to before title

* Always link to discussion

* Automatically open discussion links in new tab

* Reorder preamble items & fix some rendering issues

* Fix page title for ERCs

* Add descriptions

* @SamWilsn's authorlist suggestion

* Some changes that @SamWilsn suggested

* Update authorlist to use no break spaces

* Make data wrap better & center-align discussion link

* Move @ into GitHub link

* Actually center link

* Use table layout instead of an actual table

* Fix table formatting

* Go back to normal table layout

* Add magic sauce

* Add unknown magical @SamWilsn code

I hope you know what you're doing

Co-authored-by: Sam Wilson <[email protected]>

* TIL there IS an else tag

* 🤦‍♂️🤦‍♂️ Double facepalm

* Add inline svg style

* Use inline SVG styling & add discussion bubble

* Remove third typo

* Add styling to make SVG links a bit better

* Add no-underline class

* Add no-underline class to icon links

* Add padding to footer to fix some styling issues

* Target the right class

* Fix footer

* Use different target for footer fix

* Final(tm) footer fix

* Use Sam's magic answer with SCSS and see how it turns out

* Fix it

* Update content-width to 100%

* Oops typo

* Make icons a tad bit smaller

* Make badges a bit bigger

* Add EIP- prefix to requires items

TODO: maybe use ERC prefix when needed?

* Fix width

* Lower font size

Co-authored-by: Sam Wilson <[email protected]>
@Pandapip1 Pandapip1 deleted the Pandapip1-new-frontmatter-rendering branch February 17, 2023 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants