search

camunda / camunda-docs

Camunda 8 Documentation, including all components and features
https://docs.camunda.io/
Other
54 stars 184 forks source link

Prepare for docusaurus v3 #2719

Open pepopowitz opened 1 year ago

pepopowitz commented 1 year ago

Docusaurus v3 is now in beta and the official release is around the corner. This is the perfect time to start preparing your site for this new major version.

https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3

There is anecdotal data from the write-the-docs slack that performance is improved in v3.

akeller commented 1 year ago

I saw they anticipate releasing V3 in the next few days unless something big comes up.

akeller commented 1 year ago

I'm glad to see they acknowledged the MDX upgrade and infrastructure changes were the bulk of this release.

I did see two interesting features highlighted:

I don't know how much we'll be able to do with code blocks, but I'm a sucker for interactive experiences.

I didn't realize draft:true was already available for docs and pages (I thought this was a blog only feature). This and the unlisted:true option could help us with some of the feedback that came up in retros around proactive docs authoring or reviewing content without running it locally. CC @christinaausley

☝ I'll create two issues for the draft and unlisted content, respectively. I'd like to see us incorporate a strategy for using the draft feature and then when we move to V3, a strategy for using unlisted.

akeller commented 10 months ago

This came up during our 8.4 docs retro as a possible idea to explore to keep our build times down.

akeller commented 1 week ago

Here is a dump of the npx docusaurus-mdx-checker results - https://docs.google.com/spreadsheets/d/1IvTrYlxrqr1BgOqY8csPDyFH5Rc_2-hrtvajVJskvTY/edit?usp=sharing