The geth-website from ethereum

Content reviews

Tick off pages in list below when they have been reviewed by at least one member of Geth team

│ │ ├── developers
│ │ │ ├── dapp-developer
│ │ │ │ ├── custom-tracer.md (reviewed when updated at geth.ethereum.org)
│ │ │ │ ├── mobile.md (reviewed when updated at geth.ethereum.org)
│ │ │ │ ├── native-accounts.md (reviewed when updated at geth.ethereum.org)
│ │ │ │ ├── native-bindings.md (reviewed when updated at geth.ethereum.org)
│ │ │ │ ├── native.md (reviewed when updated at geth.ethereum.org)
│ │ │ │ ├── tracers.md (reviewed when updated at geth.ethereum.org)
│ │ │ │ └── built-in-tracers.md (reviewed when updated at geth.ethereum.org)
│ │ │ └── geth-developer
│ │ │ ├── code-review-guidelines.md
│ │ │ ├── contributing.md
│ │ │ ├── devguide.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── dev-mode.md
│ │ │ ├── dns-discovery-setup.md
│ │ │ ├── issue-handling-workflow.md
│ │ │ ├── private-network.md (reviewed when updated at geth.ethereum.org)
│ │ ├── faq.md
│ │ ├── fundamentals
│ │ │ ├── Backup--restore.md
│ │ │ ├── Command-Line-Options.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── les.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── account-management.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── node-architecture.md
│ │ │ ├── security.md
│ │ │ ├── peer-to-peer.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── mining.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── pruning.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── sync-modes.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── logs.md (reviewed when updated at geth.ethereum.org)
│ │ ├── getting_started
│ │ │ ├── consensus-clients.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── getting-started-with-clef.md (reviewed when updated at geth.ethereum.org)
│ │ │ └── getting-started.md (reviewed when updated at geth.ethereum.org)
│ │ │ └── Installing-Geth.md (reviewed when updated at geth.ethereum.org)
│ │ │ └── hardware-requirements.md (reviewed when updated at geth.ethereum.org)
│ │ ├── interacting_with_geth
│ │ │ ├── JavaScript-Console.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── JavaScript-Console_Contracts.md (reviewed when updated at geth.ethereum.org)
│ │ │ └── RPC
│ │ │ ├── batch.md
│ │ │ ├── graphql.md
│ │ │ ├── ns-admin.md
│ │ │ ├── ns-clique.md
│ │ │ ├── ns-debug.md
│ │ │ ├── ns-eth.md
│ │ │ ├── ns-les.md
│ │ │ ├── ns-miner.md
│ │ │ ├── ns-net.md
│ │ │ ├── ns-personal.md
│ │ │ ├── ns-personal-deprecation-notes.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── ns-txpool.md
│ │ │ ├── objects.md
│ │ │ ├── pubsub.md
│ │ │ └── server.md (reviewed when updated at geth.ethereum.org)
│ │ ├── monitoring
│ │ │ ├── dashboards.md (reviewed when updated at geth.ethereum.org)
│ │ │ └── metrics.md (reviewed when updated at geth.ethereum.org)
│ │ │ └── ethstats.md
│ │ └── tools
│ │ ├── abigen (reviewed when updated at geth.ethereum.org)
│ │ ├── Clef
│ │ │ ├── apis.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── CliqueSigning.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── datatypes.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── Introduction.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── Rules.md (reviewed when updated at geth.ethereum.org)
│ │ │ ├── Setup.md (reviewed when updated at geth.ethereum.org)
│ │ │ └── Tutorial.md (reviewed when updated at geth.ethereum.org)
│ │ └── puppeth
│ │ └── devp2p (reviewed when updated at geth.ethereum.org)
│ └── downloads.md
│ └── resources.md
│ └── homepage.md

[Logic bug] - Last edited timestamp is incorrect

Last edited logic appears to be incorrect. It's showing every page as last edited today.
I'd expect it to show when the page itself was last edited.

[DESIGN BUG] Left navigation extra pixel

there is an extra pixel border in the left navigation, button border I guess.

[UI bug] - Overflow on developer docs with long code blocks

On mobile: long code blocks cause a horizontal scroll

Top image in download it's a pixel svg

This image is kinda blurry. Being a SVG was not supposed to be.

As far as I could inspect the SVG, looks like pixel image inside SVG.

file: gopher-downloads-front-light.svg

[Design] - Links are missing active / pressed state.

[Design bug] No padding between markdown content and right sidebar

[logic & styles] Primary releases should have bold text

On releases tables from /downloads page, primary releases should have font weight: 700.

latest 64bit archive for geth and geth/tools on linux
64bit installer for the same on windows
64bit archives on maxos
latest one on android and ios

A release is considered primary when:

os === "android" && arch === "all"
os === "ios" && arch === "all"
os === "linux" && arch === "64-bit"
os === "darwin" && arch === "64-bit"
os === "windows" && arch === "64-bit" && kind == "Installer"

Check https://geth.ethereum.org/downloads/

[DESIGN BUG] Left navigation icon with 2px width

Left navigation icon with 2px width on the svg

figma screenshot

browser screenshoot

[UI bug] - Incorrect spacing on docs table of contents

Spacing between elements on the table of contents is currently 24px
The design specifies 14px

quick link h2 not in the same style

the title is not in the same style like the others h2

[DESIGN UPDATE] notes box render in html

On the current website, there is a note box on the dev docs that render like this

Docs: Bullet point lists rendering in green

Text in bullet-point lists are rendering the same as links, which is a bit confusing. They should just look like normal text IMO.

e.g.

Fix extra margin on first header in docs

Ideas for new pages

These are pages not currently included on the website but might be nice to add after the new site is live:

downloads table expand button returns nonsense values in text

Description

Clicking "show older entries" on the tables on the downloads page expands the table but also returns the following text in the table's footer:

"Showing 20 latest releases of a total 12 releases"

You can't be showing 20 out of 12, so I assume the logic is screwed up somewhere.

Also, clicking the button again does not change the table layout, but does increase the numerator by ten each time, so the text updates e.g.:

click -> "Showing 20 latest releases of a total 12 releases"
click -> "Showing 30 latest releases of a total 12 releases"
click -> "Showing 40 latest releases of a total 12 releases"

This applies to both tables.

[DESIGN BIG] responsive behaviour

weird responsive behaviour

Is there a reason?

[sorting] releases should be sorted by date, then by type (Geth, then Geth + tools)

On /downloads page, in the releases tables, releases should be sorted by date first and then by type (Geth, Geth & Tools), e.g.:

Geth 1.10.26
Geth & Tools 1.10.26

Epic Tracker

This epic is part of the ethererum.org Q3 2022 roadmap & Q4 2022 roadmap.

Overview

This repository is a temporary home for the new Geth website while it is in development.
Project management notes are available on the EF Q3 Sprint planning Notion here.

Ethereum.org team is @jmcook1186 @nloureiro @nhsz @corwintines @samajammin

The following outlines the outstanding tasks to complete for this epic:

Tasks

Project Management tasks

Top level PM Notion

Scope epic Notion
internal kick-off meeting e.org
kick-off meeting e.org <> geth
get approval on content plan from geth team
audit media on site - what needs creating/replacing?

Design Tasks

sketch out figma designs (Notion
choose final design idea
get approval of final design from geth team
new/updated media files

Dev tasks

determine downloads page strategy Notion
determine overall site strategy Notion
define json-rpc api page strategy Notion
configure preview deploys for this repo
determine search strategy Notion
define hosting/deploy Notion
Build site v1!
launch

Content tasks

initial

draft content management plan Notion
migrate material from geth.ethereum.org

deployment

create new website branch in ethereum/go-ethereum
raise PR to move website code from geth-website/master to go-ethereum/website
set up netlify for go-ethereum
move geth.ethereum.org dns to new site

pages

(tick when created/migrated/updated and ready for review)
Notion
The review status of each page is documented in the Notion doc linked above.

Content admin

make sure all pages are correctly formatted according to SPEC
make sure content pages have been reviewed by someone from Geth team

refactor `/docs` to use MDX instead of `react-markdown` for .md rendering

we should be using MDX for /docsrendering to have more fexibility and the ability to inject react code in them.

Markdown formatting consistency

This issue tracks which pages have been audited for formatting consistency.
The spec for page formatting is here

Frontmatter for pages

title - title tag for the page (ideally <60 characters)
- More info on title tags: https://moz.com/learn/seo/title-tag
description - meta description of the page (ideally <160 characters)
More info on meta descriptions: https://moz.com/learn/seo/meta-description
-

Internal linking structure

Links
- Use absolute URIs, e.g.
  - Return [home](/)
  - View the [contribution guidelines](/docs/developers/contributing)
- Do NOT use relative URIs, e.g.
  - Return [home](../)
  - View the [contribution guidelines](../../docs/developers/contributing)
Images
- Place images in the /public/images/ directory
- Use absolute links regardless of where the markdown file is, i.e.
  - ![some image alt-text](/images/cool-image.png)
- Do NOT use relative URIs, e.g.
  - ![some image alt-text](../../images/cool-image.png)

Tick off when formatting is completed

[UI bug] - Border sizes are inconsistent on downloads page

The first box has a bigger border than the boxes that follow:

[DESING BUG]on dark theme all the text should be “yellow”

Don’t use #fff use #F0F2E2 for everything on dark

[DESIGN BUG] center the text and use the small text size

where is the footer?

As far as I could check preview links, I haven't seen the footer anywhere.

is it on some other branch?

add last modified to getStaticProps in [...slug].tsx

Add logic to get last modified date for markdown file in getStaticProps for [...slug].tsx

[UI/UX bug] - Footer buttons are only partially clickable

The entire button link should be clickable in the footer
This bug is not present in top nav / other button links on page

Downloads page: some releases in bold, N rows in tables

The tableis limited to 10 rows in the default view - there are 12 "latest" entries on Linux so it doesn't make sense to have 2 hidden behind a "load older entries" button.

From Peter: "we wanted to always display the last 2 versions - independent of how many lines that is - and if it's not yet 10, keep pulling more in - we should retain that logic"

[REFACTOR] Quicklinks.tsx

Some duplicate styles on a set of Stack components in the QuickLinks component. We can create a variant for this as a cleanup task.

<Stack
      data-group
      bg='green.50'
      _hover={{ textDecoration: 'none', bg: 'brand.light.primary', color: 'yellow.50' }}
      _focus={{
        textDecoration: 'none',
        bg: 'brand.light.primary',
        color: 'yellow.50',
        boxShadow: 'inset 0 0 0 3px #f0f2e2 !important'
      }}
      _active={{
        textDecoration: 'none',
        bg: 'brand.light.secondary',
        color: 'yellow.50'
      }}
      justifyContent='center'
      h='100%'
      p={4}
>

h2 size is too big

Because we changed from h3 to h2, in the design system, we downsized the font size too.

check the comparison

footer has inconsistent [padding making text not being vertically aligned

in the footer there's like an extra padding, bottom being bigger than top and makes the text not being vertically aligned

[DESGIN BUG]h2 font size to 1.75rem

[Logic bug] - Breadcrumbs contains header id

When in the developer docs: if I click a header ID or navigate directly to a URL including a header ID (e.g. https://melodious-puffpuff-8e1109.netlify.app/docs/fundamentals/node-architecture#consensus-client), I see the header ID included in the breadcrumbs

[UX suggestion] - Use universal date times

The current formatting (12/1/2022) is confusing for most of the world outside of the US that uses the dd-mm-yyyy (read: more logical 😜) format.

IMO we should use something that is more universal to comprehend.

See how we handle this on ethereum.org:

Downloads page: table expansion descriptions

The description adjacent to the "show older releases" button isn't quite right because the number we quote for the total available entries is for individual build artifacts, not releases (release is, e.g. v1.10.26). Either change the wording from "releases" to "build artifacts" or just remove and only have "load more" button.

From Peter:

"Also the line Showing 20 latest releases of a total 1879 releases is a bit wonky, because there are not 1879 releases, but perhaps build artifacts. I'm not sure this is really needed, maybe just having the button there to load more releases is enough.

The spacing between sections of the developer docs is too large.
The Figma file specifies 64px between the final element and the next H2
We've got 92px margin between last paragraph and start of the next heading (28px bottom + 64px top).

These margins should collapse: