Migrate to docusaurus

[jeluard]

Motivation

Migrate documentation to docusaurus. Test the deployment here

Relates to #6517

[codecov]

Codecov Report

Merging #6533 (e129356) into unstable (6fe93c1) will decrease coverage by 0.14%.
Report is 10 commits behind head on unstable.
The diff coverage is n/a.

Additional details and impacted files

@@             Coverage Diff              @@
##           unstable    #6533      +/-   ##
============================================
- Coverage     61.53%   61.39%   -0.14%     
============================================
  Files           556      556              
  Lines         58647    58751     +104     
  Branches       1847     1848       +1     
============================================
- Hits          36087    36073      -14     
- Misses        22520    22638     +118     
  Partials         40       40              

[nflaig]

I really like the side bar on the right we have for the CLI reference, listing all flags. Would be good if we can keep that

[nflaig]

We definitely need a detailed visual review of the new docs vs. our current docs, just quickly skimming through

• https://jeluard.github.io/lodestar/logging-and-metrics/client-monitoring (<> needs to be escaped now)
  

• https://jeluard.github.io/lodestar/advanced-topics/setting-up-a-testnet (Syntax highlighting doesn't work)
  

• footer looks misaligned
  

• do we wanna look into adding versioning, or at least show the lasted version here?
  

[matthewkeil]

Suggested change

	"_Supports all parent command options plus the following:_\n\n"
	`_Supports all parent command options plus the following:_${LINE_BREAK}`

[jeluard]

Is that a docusaurus thing? Couldn't find mention of it.

[matthewkeil]

No. That was a remnant from updating the script to build the cli docs. In some places the line separator needed the extra <br /> but in other it did not to look correct. As long as it no longer a thing we can just use the single LINE_BREAK const.

[matthewkeil]

Really nice job overall!! Just a few things I noticed but great work!

Just as a note I did not visually check all the pages, I only reviewed the github diff and started things up to make sure all worked on my box as well (WOMM works on my machine lol). There was a lot here so we may need another bite at the apple.

But again, great addition to the codebase!! 🚀

[matthewkeil]

I really like the side bar on the right we have for the CLI reference, listing all flags. Would be good if we can keep that !

I also very much agree with this!!! I saw some options for generating a minimap so should be possible

[philknows]

I really like the side bar on the right we have for the CLI reference, listing all flags. Would be good if we can keep that

Definitely useful. Would love if there was a way to get the list of commands on the right sidebar, that seems to be able to show the heading titles?

[philknows]

• do we wanna look into adding versioning, or at least show the lasted version here?

I think this would be a good idea if we can implement this.

[philknows]

I think overall this is a good start, with this PR focusing on the migration itself, we should aim to get this setup with the top level settings we want and the high level structure of our docs. We can then do follow up PRs also which can go further into the contents of the docs such as rearranging and cleaning up context.

[jeluard]

@nflaig

The footer is the regular docusaurus one, it looks a bit off because it doesn't contain much for now. We could revisit this once we adapt the doc layout.

Regarding versioning, I plan to address that in a follow up PR.

[matthewkeil]

Looks good. Talked with @jeluard in DM and a couple of the clean-up things will be handled in separate PR. You rock dude!! Good job! 🎸

[wemeetagain]

🎉 This PR is included in v1.18.0 🎉