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

[WIP] Upgrade to Docusaurus 3 #1157

Draft
wants to merge 2 commits into
base: staging
Choose a base branch
from

Conversation

Mercurial
Copy link
Contributor

No description provided.

@Mercurial Mercurial mentioned this pull request Oct 4, 2023
2 tasks
@katomm
Copy link
Member

katomm commented Oct 4, 2023

Hey Clark, great to see you. Can we briefly discuss beforehand if we want to go through another beta update hell with the portal and have constant UI and other breaking changes likely?

@Mercurial
Copy link
Contributor Author

Mercurial commented Oct 4, 2023

Hey Clark, great to see you. Can we briefly discuss beforehand if we want to go through another beta update hell with the portal and have constant UI and other breaking changes likely?

for sure, thats why this is just a draft to start that process, infact we can merge this PR once v3 is released to ensure stability and just keep track of the beta and make sure the portal is ready for the release

@katomm
Copy link
Member

katomm commented Oct 20, 2023

Docusaurus 3.0 RC is out facebook/docusaurus#9429

it felt like the beta had just launched.

@Mercurial
Copy link
Contributor Author

Let's goo, time get my hands dirty 😅. Will check what compatibility issues needs to be fixed

@Mercurial
Copy link
Contributor Author

Mercurial commented Oct 21, 2023

After looking further, heres a list of compatiblity issues I've found so far.

  • The changelog-plugin is incompatible and will need to be updated, it seems to be looking for files under developer-portal/.docusaurus/docusaurus-plugin-content-blog/changelog/ but the actual files are in developer-portal/.docusaurus/changelog-plugin/default
  • MDX parser is much more strict now and complaints when parsing the CIP markdown files
    For example this section:
#### Calculate the change to send back to `payment.addr`

All amounts must be in Lovelace:

   expr <UTXO BALANCE> - <AMOUNT TO SEND> - <TRANSACTION FEE>

The parser thinks it <TRANSACTION FEE> should have a closing tag.

Could be a good oppurtunity to rewrite the CIP into a blog content plugin-aswell. That way we can display the authors much more clearly since the blog already has support for that.

P.S this is by no means a comprehensive list of compatiblity issues

@rphair
Copy link
Collaborator

rphair commented Oct 21, 2023

@Mercurial @katomm if we could suppress the interpretation of opening tags it would be a big help to the CIP process. As it is now, we've had to make more changes like these to stop headers from being wiped out after the first < character:

... which has been OK so far, since we've cleaned up the formatting of code segments used as document headers, but over time would have to enforce this in every bit of pseudocode like the above... which would be a full-time job. 😰

@Mercurial Mercurial changed the title initial work to upgrade to docusaurous v3-beta0 [WIP] Upgrade to Docusaurus 3 Oct 28, 2023
@katomm
Copy link
Member

katomm commented Nov 17, 2023

@fill-the-fill could you please look into the points that @Mercurial raised above?

@rphair
Copy link
Collaborator

rphair commented Dec 13, 2023

@katomm @Mercurial it's out of RC! 🤓 Just seen tonight in local build: Update available 2.4.3 → 3.0.1

@katomm
Copy link
Member

katomm commented Dec 13, 2023

@fill-the-fill or @Mercurial did not answer yet, so clever to put this on hold for now. (In particular before Christmas)

@rphair
Copy link
Collaborator

rphair commented Jan 30, 2024

@katomm @fill-the-fill @Mercurial newer version ready now 🤠🚀

Update available 2.4.3 → 3.1.0

@katomm
Copy link
Member

katomm commented Jun 1, 2024

@fill-the-fill, six months passed, any opinion on this? Thanks

@katomm
Copy link
Member

katomm commented Jul 5, 2024

Hate to be the guy, but can we please get an answer here @fill-the-fill

@rphair
Copy link
Collaborator

rphair commented Jul 5, 2024

another advantage to upgrading: to fix some outdated packages likely not reconcilable with the current Docusaurus version's package configuration, e.g. (observable in local build):

Browserslist: caniuse-lite is outdated. Please run:
  npx update-browserslist-db@latest
  Why you should do it regularly: https://github.com/browserslist/update-db#readme

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