Docs/sofie-2869/docusaurus v3

nrkno / sofie-core

Sofie Core: A Part of the Sofie TV Studio Automation System

https://github.com/nrkno/Sofie-TV-automation/

MIT License

124 stars 40 forks source link

Docs/sofie-2869/docusaurus v3 #1184

Closed jesperstarkar closed 2 months ago

jesperstarkar commented 2 months ago

About the Contributor

On behalf of the NRK Sofie team

Type of Contribution

This is a documentation improvement

Current Behavior

Docusaurus runs version 2.4

New Behavior

Docusaurus bumped to version 3. The motivation behind this was to easily install extensions, prompted by the need for mermaid.js extension.

Testing

[ ] I have added one or more unit tests for this PR
[ ] I have updated the relevant unit tests
[ ] No unit test changes are needed for this PR

Affected areas

Time Frame

Other Information

Status

[ ] PR is ready to be reviewed.
[x] The functionality has been tested by the author.
[ ] Relevant unit tests has been added / updated.
[x] Relevant documentation (code comments, system documentation) has been added / updated.

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 58.07%. Comparing base (fec30c4) to head (7a6d881). Report is 26 commits behind head on release51.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## release51 #1184 +/- ## ============================================= + Coverage 57.87% 58.07% +0.20% ============================================= Files 519 519 Lines 83691 83783 +92 Branches 4318 4413 +95 ============================================= + Hits 48437 48660 +223 + Misses 35201 35093 -108 + Partials 53 30 -23 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

jesperstarkar commented 2 months ago

I have spent some time just clicking around, and I can't directly see any regressions. Though, i don't really know what would potentially have been affected by this.

My suggestion is to run with it, and fix regressions if and when they appear in the wild.