go-ethereum icon indicating copy to clipboard operation
go-ethereum copied to clipboard

website/docs: Write missing doc pages

Open adamschmideg opened this issue 5 years ago • 5 comments

  • [x] light client overview (@adamschmideg)
  • [x] geth system requirements
  • [x] command line options (@fjl)
  • [x] puppeth
  • [x] config file (@ChrisChinchilla)
  • [x] ethclient
  • [x] Go API
  • [x] Geth architecture overview (consensus engine, etc)
  • [x] sync modes (@ChrisChinchilla)
  • [x] graphql
  • [x] clef ui
  • [x] hardware requirements
  • [ ] goevmlab / traceview
  • [x] caching (gcmode, flushing tries after timeout etc.)
  • [x] update FAQ page re fast sync being dropped and common snap sync issues
  • [x] individual built-in tracers (e.g. prestateTracer, unigramTracer etc.)
  • [x] other built-in commands like devp2p, abigen, etc.
  • [x] more in-depth cli cmd description: e.g. how to prune your node

adamschmideg avatar Nov 11 '19 09:11 adamschmideg

Please don't ask if you can work on this, just pick a topic that you want to write about and send a pr if you think you have appropriately captured the topic.

MariusVanDerWijden avatar Nov 03 '21 13:11 MariusVanDerWijden

@ligi @adamschmideg @MariusVanDerWijden @s1na @jmcook1186 @Zachinquarantine what branch should I push the code to? TIA

vj-codes avatar Aug 01 '22 15:08 vj-codes

if you are adding docs please raise a PR to the gh-pages branch.

jmcook1186 avatar Aug 01 '22 15:08 jmcook1186

goevmlab / traceview should not have a doc-section in the go-ethereum repo, it is a standalone repo. Looks like we can (almost?) close this ticket?

holiman avatar Feb 02 '23 08:02 holiman

i think it would be good to also add a page on config files. At the moment they are only mentioned in the "connecting to the network" page. I'll do this asap and then I agree this can be closed out.

jmcook1186 avatar Feb 02 '23 12:02 jmcook1186