docs: update docsgen scripting and add new docs content #6134
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Performance Report✔️ no performance regression detected Full benchmark results
|
dapplion
reviewed
Nov 28, 2023
Co-authored-by: Cayman <[email protected]>
Co-authored-by: Cayman <[email protected]>
Co-authored-by: Cayman <[email protected]>
Co-authored-by: Cayman <[email protected]>
nazarhussain
previously approved these changes
Dec 8, 2023
nflaig
reviewed
Dec 8, 2023
| # Install from NPM [not recommended] | ||
|
|
||
| <!-- prettier-ignore-start --> | ||
| !!! danger |
There was a problem hiding this comment.
Might wanna keep this as a warning so people don't install lodestar via npm
There was a problem hiding this comment.
Updated.
Im curious if we should not publish the package anymore to prevent against this.
There was a problem hiding this comment.
Could be installed as a package in another project in which case it would have a lock file again. I don't know if anybody is doing that though.
There was a problem hiding this comment.
There are 793 install / week listed on NPM. Curious if that is all us and CI?
There was a problem hiding this comment.
Curious if that is all us and CI?
I have never installed the package, I don't see us doing that in the CI either. Not sure who installs that to be honest, the README of the package is also a bit out of date.
There was a problem hiding this comment.
I read in a comment in our code in depgraph.md.
I did a search on github and it seems the only references to @chainsafe/lodestar as a dependency are only very old forks.
Since its a security risk, perhaps we should stop publishing it and make it hidden for now and see who squeals that its gone. What do you think @dapplion and @wemeetagain?
There was a problem hiding this comment.
I'd like to solve via #3596
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## unstable #6134 +/- ##
=============================================
+ Coverage 0 80.02% +80.02%
=============================================
Files 0 19 +19
Lines 0 1717 +1717
Branches 0 155 +155
=============================================
+ Hits 0 1374 +1374
- Misses 0 341 +341
- Partials 0 2 +2 |
nazarhussain
approved these changes
Dec 11, 2023
g11tech
approved these changes
Dec 11, 2023
nflaig
approved these changes
Dec 11, 2023
wemeetagain
approved these changes
Dec 12, 2023
jeluard
approved these changes
Dec 12, 2023
|
Merging this now for inclusion in 1.13, we can continue to address doc improvements in future PRs. |
|
🎉 This PR is included in v1.13.0 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Adds to, and updates, existing docs site. Part of #5961 resolution. More to be added but this PR is getting pretty big as-is.
Description
Includes a bunch of new documentation content and also updates how the auto-generated documentation is rendered from the cli package.
Steps to start docs site locally
yarn build yarn build:docs cd docs pip install --user -r requirements.txt mkdocs serve -w pagesNavigate via browser to
http://127.0.0.1:8000/lodestar/