Documentation Updates #5961
Comments
matthewkeil
added
meta-discussion
Potential Layout
|
|
Comments forwarded from discord by @wemeetagain:
@wemeetagain would like to tackle typescript/javascript usage of lodestar packages |
|
|
As suggested in the standup we could embed a API reference page (similar to CLI reference), I used redoc previously to do this and the results were pretty good, see Docker HUB API for an example. This should be really easy to achieve once we know how to generate a openapi.json file which is already required by #1060. Redoc just needs a reference to the generated file (https://github.com/Redocly/redoc#tldr-final-code-example) and will generate everything from that. File should be ideally served from the same domain as the docs page itself. |
|
New contributor guide/getting started section for developers:
|
|
As discussed in Turkey, it makes sense to PR a documentation structure change to outline the docs better, then continuously contribute to updating the content within it. This way, we minimize issues with conflicts and rebasing your branch here https://github.com/ChainSafe/lodestar/tree/mkeil/redo-docs. The new structure contained within here are laid out much better and we can continuously update the content as we dedicate more time to making it more complete @matthewkeil . |
|
As discussed on the March 5, 2024 standup, it was discussed that we would begin migration to Docusaurus for Lodestar docs due to its flexibility, React-based framework, and compatibility with current web technologies. It is important to note that this is not just platform change, but also an opportunity for us to vastly improve DevEx as described by some suggestions here: #6493 (reply in thread) As part of migration we also need to figure out how to identify external links to our documentation and update as many to link the new doc URLs. From Github insights, the following traffic we can identify to our repo is:
As of today, our Google indexer shows the following external links to our documentation are: |
|
For some alignment on how other ChainSafe projects are setting up their Docusaurus pages, see https://handbook.chainsafe.io/development/documentation/ |
Problem description
We would like to update our documentation. We would like to foster communication between the team and the community to make sure the docs included all of the best and none of the rest!! 🥷
Solution description
We are researching the other client docs and will incorporate the most important sections from each to create a complete set of docs for Lodestar and the broader consensus client ecosystem.
Additional context
Lodestar Docs: https://chainsafe.github.io/lodestar
Lighthouse Docs: https://lighthouse-book.sigmaprime.io/
Prysm Docs: https://docs.prylabs.network/docs/getting-started
Teku Docs: https://docs.teku.consensys.net/
Nim Docs: https://nimbus.guide/
The text was updated successfully, but these errors were encountered: