[Docusaurus] Fix broken links #2720
Closed
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
tutorials were moved to the /docs/tutorials directory, api reference was moved to an external site
Docusaurus has checks to validate our links are not broken. To make Docusaurus aware of anchors we create we use the <Heading> component they provide.
Would have prevented us from publishing the site with broken links. For broken anchors we just warn since those still take us to the correct page.
facebook-github-bot
added
the
CLA Signed
|
@CristianLara has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2720 +/- ##
=======================================
Coverage 99.98% 99.99%
=======================================
Files 203 203
Lines 18671 18671
=======================================
+ Hits 18669 18670 +1
+ Misses 2 1 -1 ☔ View full report in Codecov by Sentry. |
saitcakmak
approved these changes
Feb 3, 2025
facebook-github-bot
pushed a commit
to facebook/Ax
that referenced
this pull request
Feb 3, 2025
Summary: ## Context Duplicate of same change in botorch: pytorch/botorch#2720 ## Motivation The recent website upgrade moved the location of tutorials and api reference breaking existing links to those. Here we fix those links and also configure Docusaurus to raise an error on broken links in the future. Pull Request resolved: #3300 Test Plan: Docusaurus checks for broken links when creating a production build. Running `./scripts/make_docs.sh -b` now results in a clean build with no broken links reported. ## Related PRs - #3294 Reviewed By: saitcakmak, Balandat Differential Revision: D69036887 Pulled By: CristianLara fbshipit-source-id: 1f95fca91a3715e9642da349eb58fa9622d9fdeb
|
@CristianLara merged this pull request in b197bf1. |
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
The recent website upgrade moved the location of tutorials and api reference breaking existing links to those. Here we fix those links and also configure Docusaurus to raise an error on broken links in the future.
Test Plan
Docusaurus checks for broken links when creating a production build. Running
./scripts/build_docs.sh -bnow results in a clean build with no broken links reported.Related PRs