Skip to content

chore(docusaurus): upgrade to v3.7.0 #4076

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

Merged
merged 5 commits into from
Apr 16, 2025
Merged

chore(docusaurus): upgrade to v3.7.0 #4076

merged 5 commits into from
Apr 16, 2025

Conversation

thetaPC
Copy link
Contributor

@thetaPC thetaPC commented Apr 15, 2025

Issue URL: internal

What is the current behavior?

Docs is using Docusaurus v3.0.1.

What is the new behavior?

Updated to the latest Docusaurus

  • Updated the swizzled files to have the latest content
  • Removed the Books page. It was causing the docs site to fail to compile due to a link issue. Instead of fixing it, it was removed since anyone with that page link gets redirected to an external site so there's no need to keep it.
  • Enabled the version status banner. This will render a banner stating that the selected version is no longer being maintained. This would make it easier for developers to know which version is up to date. This banner can be seen when v7 is selected.

Screenshot 2025-04-15 at 11 47 12 AM

Does this introduce a breaking change?

  • Yes
  • No

Other information

Preview

Copy link

vercel bot commented Apr 15, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
ionic-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 16, 2025 7:46pm

@thetaPC thetaPC marked this pull request as ready for review April 15, 2025 21:15
@thetaPC thetaPC requested a review from a team as a code owner April 15, 2025 21:15
@thetaPC thetaPC requested review from gnbm, ShaneK and brandyscarney and removed request for gnbm April 15, 2025 21:15
Copy link
Member

@ShaneK ShaneK left a comment

Choose a reason for hiding this comment

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

Looks good to me 🚀

Copy link
Member

@brandyscarney brandyscarney left a comment

Choose a reason for hiding this comment

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

This looks good but can the banner text be changed? Maybe like:

-This is documentation for Ionic Documentation v7, which is no longer actively maintained.
+This is the documentation for Ionic Framework v7, which is no longer actively maintained.
-For up-to-date documentation, see the [latest version](https://ionic-docs-git-docusaurus-upgrade-ionic1.vercel.app/docs/) (v8).
+For the most up-to-date documentation, see the [latest version](https://ionic-docs-git-docusaurus-upgrade-ionic1.vercel.app/docs/) (v8).

@thetaPC
Copy link
Contributor Author

thetaPC commented Apr 16, 2025

Discussed offline regarding the banner text. Since it would consist of swizzling the component, it was decided to leave it alone. The site title was updated to reflect accurately on the banner: fbb9ccd

@thetaPC thetaPC merged commit 03525ee into main Apr 16, 2025
4 checks passed
@thetaPC thetaPC deleted the docusaurus-upgrade branch April 16, 2025 19:54
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.

3 participants