Comments (2)
The solution is to integrate a link checker in our CI using something like https://github.com/UmbrellaDocs/linkspector as part of our check docs workflow.
irrespective of enabling proper link checking in docusaurus, we will still need something like this for external links, and references from other files like README.md
from lodestar.
It looks like docusaurus is already able to detect some broken links but requires to run a production build
docusaurus build
Running this on unstable branch
[WARNING] Docusaurus found broken links!
Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
Exhaustive list of all broken links found:
- Broken link on source page path = /lodestar/contribution/getting-started:
-> linking to .devcontainer/devcontainer.json (resolved as: /lodestar/contribution/.devcontainer/devcontainer.json)
- Broken link on source page path = /lodestar/libraries/lightclient-prover/prover:
-> linking to ./src/provider_types/ (resolved as: /lodestar/libraries/lightclient-prover/src/provider_types/)
@jeluard do you know why we only log a warning if links are broken? the default seems to be that docusaurus throws an error if links are broken which seems better to me
lodestar/docs/docusaurus.config.ts
Lines 23 to 24 in 79a008f
See related docs
from lodestar.
Related Issues (20)
- Add Grandine to known client list HOT 1
- Error upgrading BeaconState HOT 4
- Review repository urls of network configs HOT 1
- Consider enabling debug namespace by default HOT 3
- v1.19.0-rc.0 high gc time HOT 1
- Replace GET validators api calls with POST api where possible
- Investigate `mapValues` type mapping issue
- Implement `engine_getPayloadBodiesByRangeV2` on electra branch HOT 1
- Add option to server to disable JSON responses HOT 2
- Review beacon api routes and remove no longer supported apis
- Add support for ssz response to `getLightClientUpdatesByRange`
- Implement EIP-7716: Anti-correlation attestation penalties for analysis
- Delayed block production on builder flow
- Add grafana panel for reorg related metrics
- Lodestar stopped keeping up with head on mainnet HOT 16
- Convenience script to further simplify binary installation
- Historical block / state pruning HOT 2
- Redirects to new docs pages do not work
- Add v2 attestation APIs to support EIP-7549 HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from lodestar.