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

[website] Bump Docusaurus to 3.1.1 and fix broken anchors #3948

Merged
merged 1 commit into from
Mar 26, 2024

Conversation

jackkoenig
Copy link
Contributor

The website build has started failing for an unknown reason, but there was a warning about the Algolia integration and bumping Docusaurus seems to fix the issue. Docusaurus 3.1.1 introduces checks for broken anchors which is also fixed in this PR. One of the broken anchors was to a section on FixedPoint, as FixedPoint was removed, this section was deleted.

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Documentation or website-related

Desired Merge Strategy

  • Squash

Release Notes

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

The website build has started failing for an unknown reason, but there
was a warning about the Algolia integration and bumping Docusaurus seems
to fix the issue. Docusaurus 3.1.1 introduces checks for broken anchors
which is also fixed in this PR. One of the broken anchors was to a
section on FixedPoint, as FixedPoint was removed, this section was
deleted.
@jackkoenig jackkoenig added the Documentation Only changing documentation label Mar 26, 2024
@jackkoenig jackkoenig added this to the 6.x milestone Mar 26, 2024
@jackkoenig jackkoenig merged commit 946392f into main Mar 26, 2024
17 checks passed
@jackkoenig jackkoenig deleted the bump-docusaurus-and-fix-website branch March 26, 2024 19:04
@mergify mergify bot added the Backported This PR has been backported label Mar 26, 2024
mergify bot pushed a commit that referenced this pull request Mar 26, 2024
The website build has started failing for an unknown reason, but there
was a warning about the Algolia integration and bumping Docusaurus seems
to fix the issue. Docusaurus 3.1.1 introduces checks for broken anchors
which is also fixed in this PR. One of the broken anchors was to a
section on FixedPoint, as FixedPoint was removed, this section was
deleted.

(cherry picked from commit 946392f)

# Conflicts:
#	docs/src/cookbooks/cookbook.md
chiselbot pushed a commit that referenced this pull request Mar 26, 2024
…3948) (#3949)

* [website] Bump Docusaurus to 3.1.1 and fix broken anchors (#3948)

The website build has started failing for an unknown reason, but there
was a warning about the Algolia integration and bumping Docusaurus seems
to fix the issue. Docusaurus 3.1.1 introduces checks for broken anchors
which is also fixed in this PR. One of the broken anchors was to a
section on FixedPoint, as FixedPoint was removed, this section was
deleted.

(cherry picked from commit 946392f)

# Conflicts:
#	docs/src/cookbooks/cookbook.md

* Resolve backport conflicts

Also warn instead of throw on broken anchors since website is published
from main rather than this branch.

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backported This PR has been backported Documentation Only changing documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants