Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: upgrade docusaurus version to 3.7 #60

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

xadahiya
Copy link
Member

Fixes #52

Checklist

  • My branch is up-to-date with upstream/main branch.
  • Everything works and is tested for major Python/NodeJS/Go versions and above.

Changes

  • Upgraded docusaurus version to 3.7
  • Cleaned up old openAPI based docs

@xadahiya xadahiya linked an issue Feb 18, 2025 that may be closed by this pull request
@xadahiya xadahiya requested review from SwaroopH and anomit February 18, 2025 10:48
@anomit
Copy link
Member

anomit commented Feb 19, 2025

Not sure why yarn build has been throwing these broken link errors. Upon manually visiting the pages and the reportedly broken links, they work fine and are linked correctly.

[INFO] 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 = /docs/build-with-powerloom/snapshotter-node/architecture:
   -> linking to /docs/protocol/specifications/snapshotter/components
   -> linking to /docs/protocol/specifications/snapshotter/snapshot-build
   -> linking to /docs/protocol/data-sources
   -> linking to /docs/protocol/data-composition
- Broken link on source page path = /docs/build-with-powerloom/snapshotter-node/full-node/health-tracking:
   -> linking to /docs/protocol/specifications/epoch#state-transitions
- Broken link on source page path = /docs/build-with-powerloom/snapshotter-node/introduction:
   -> linking to /docs/protocol/data-composition
- Broken link on source page path = /docs/build-with-powerloom/use-cases/existing-implementations/aavev3-dashboard/data-points:
   -> linking to /docs/protocol/data-composition
- Broken link on source page path = /docs/build-with-powerloom/use-cases/existing-implementations/activity-tracking/:
   -> linking to /docs/protocol/specifications/snapshotter/preloading
   -> linking to /docs/protocol/specifications/snapshotter/snapshot-build#data-source-specification-bulk-mode
- Broken link on source page path = /docs/build-with-powerloom/use-cases/existing-implementations/eth_price_tracking:
   -> linking to /docs/protocol/specifications/snapshotter/snapshot-build
   -> linking to docs/Protocol/Specifications/Snapshotter/snapshot-build (resolved as: /docs/build-with-powerloom/use-cases/existing-implementations/docs/Protocol/Specifications/Snapshotter/snapshot-build)
- Broken link on source page path = /docs/build-with-powerloom/use-cases/existing-implementations/uniswap-dashboard/closer-look-at-snapshots:
   -> linking to /docs/protocol/specifications/snapshotter/snapshot-build#base-snapshots
   -> linking to /docs/protocol/specifications/epoch
- Broken link on source page path = /docs/build-with-powerloom/use-cases/existing-implementations/uniswap-dashboard/data-points:
   -> linking to /docs/protocol/data-composition
   -> linking to /docs/protocol/data-sources
- Broken link on source page path = /docs/Protocol/data-sources:
   -> linking to /docs/protocol/specifications/snapshotter/snapshot-build#bulk-mode
   -> linking to /docs/protocol/specifications/snapshotter/preloading
   -> linking to /docs/protocol/specifications/epoch#1-epoch_released
   -> linking to /docs/protocol/specifications/snapshotter/snapshot-build
- Broken link on source page path = /docs/Protocol/Specifications/Snapshotter/components:
   -> linking to /docs/protocol/specifications/snapshotter/snapshot-build
- Broken link on source page path = /docs/Protocol/Specifications/Snapshotter/snapshot-build:
   -> linking to /docs/protocol/data-sources#static-data-sources
   -> linking to /docs/protocol/specifications/snapshotter/preloading#shipped-preloaders
   -> linking to /docs/protocol/data-sources#data-source-signaling
   -> linking to /docs/protocol/data-composition#dependency-graph
   -> linking to /docs/protocol/data-composition#single-project-composition
   -> linking to /docs/protocol/data-composition#multiple-projects-composition
- Broken link on source page path = /docs/Protocol/Specifications/Snapshotter/state-machine:
   -> linking to /docs/protocol/specifications/epoch#state-transitions
- Broken link on source page path = /docs/Protocol/Specifications/state-v1:
   -> linking to /docs/protocol/data-sources
   -> linking to /docs/protocol/data-sources#dynamic-data-sources
   -> linking to /docs/protocol/specifications/epoch#force-consensus-service
   -> linking to /docs/protocol/specifications/epoch#epoch-generator

[WARNING] Docusaurus found broken anchors!

Please check the pages of your site in the list below, and make sure you don't reference any anchor that does not exist.
Note: it's possible to ignore broken anchors with the 'onBrokenAnchors' Docusaurus configuration, and let the build pass.

Exhaustive list of all broken anchors found:
- Broken anchor on source page path = /docs/build-with-powerloom/devnet/getting-started:
   -> linking to #step-3-configure-the-environment-variables (resolved as: /docs/build-with-powerloom/devnet/getting-started#step-3-configure-the-environment-variables)
- Broken anchor on source page path = /docs/build-with-powerloom/snapshotter-node/lite-node-v2/build-sh-advanced:
   -> linking to /docs/build-with-powerloom/snapshotter-node/lite-node-v2/monitoring#21-setting-up-the-snapshotter-node
- Broken anchor on source page path = /docs/build-with-powerloom/snapshotter-node/lite-node-v2/getting-started:
   -> linking to #setting-up-multiple-nodes-on-a-vps (resolved as: /docs/build-with-powerloom/snapshotter-node/lite-node-v2/getting-started#setting-up-multiple-nodes-on-a-vps)
   -> linking to /docs/build-with-powerloom/snapshotter-node/lite-node-v2/monitoring#monitoring-node-activity-with-the-snapshotter-dashboard
- Broken anchor on source page path = /docs/build-with-powerloom/use-cases/building-new-usecase/extending-uniswapv2-dashboard:
   -> linking to /docs/build-with-powerloom/snapshotter-node/full-node/getting-started#for-code-contributors
- Broken anchor on source page path = /docs/build-with-powerloom/use-cases/building-new-usecase/tracking-wallet-interactions:
   -> linking to /docs/build-with-powerloom/snapshotter-node/full-node/getting-started#for-code-contributors
- Broken anchor on source page path = /docs/build-with-powerloom/use-cases/existing-implementations/eth_price_tracking:
   -> linking to #forking-the-computes-and-config-templates (resolved as: /docs/build-with-powerloom/use-cases/existing-implementations/eth_price_tracking#forking-the-computes-and-config-templates)
- Broken anchor on source page path = /docs/Protocol/Specifications/Snapshotter/components:
   -> linking to #epoch-generation (resolved as: /docs/Protocol/Specifications/Snapshotter/components#epoch-generation)
- Broken anchor on source page path = /docs/Protocol/Specifications/Snapshotter/snapshot-build:
   -> linking to #processor-distributor (resolved as: /docs/Protocol/Specifications/Snapshotter/snapshot-build#processor-distributor)

Copy link
Member

@anomit anomit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the links that begin with /docs/link-to-categoru/sub-link have to be replaced with /link-to-page/....

Reference: #60 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Upgrade to Docusaurus v3.6+
2 participants