docs: Update documentation to reflect changed org #1590
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Caution Review failedThe pull request is closed. WalkthroughDocumentation updated to remove NRK-specific framing, reflect Sofie Governance ownership, adjust governance and release workflows, and update external links (CasparCG/media-scanner) and minor installation references. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Member
|
This should probably be directed to the main branch so that the deployed docs are updated before release53 is released |
PeterC89
force-pushed
the
docs/update-docs
branch
from
48d9e68 to
90424a0
Compare
Contributor
Author
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Fix all issues with AI agents
In `@packages/documentation/docs/for-developers/contribution-guidelines.md`:
- Line 14: The phrase "open source applications and libraries" should use the
hyphenated compound adjective form; update the sentence in the
contribution-guidelines text (the line starting "The Sofie project includes a
number of open source applications and libraries...") to read "open-source
applications and libraries" so the compound adjective correctly modifies the
noun.
- Line 18: Change the subject-verb agreement in the sentence starting "The Sofie
Governance organisation are responsible..." by replacing "are" with "is" so it
reads "The Sofie Governance organisation is responsible..." (locate that exact
sentence in contribution-guidelines.md and update only the verb).
- Line 108: Change the sentence "When logging, use one of the **log level**
described below:" to use the plural form "log levels" so it reads "When logging,
use one of the **log levels** described below:"; update the phrase in the
contribution-guidelines content where the phrase "When logging, use one of the
**log level** described below:" appears.
- Line 16: The sentence "A list of the "Sofie repositories" [can be found
here](libraries.md).The Sofie Governance organisation owns..." is missing a
space after the period; update the text near the "libraries.md" link (the string
containing "can be found here") to insert a single space between the period and
"The" so it reads "...(libraries.md). The Sofie Governance organisation owns..."
to fix the spacing.
- Line 38: Update the sentence "When a user need is identified and described" to
use the plural form "needs" so it reads "When a user needs are identified and
described" (or better: "When user needs are identified and described"); locate
and change the exact phrase in the contribution-guidelines.md content to correct
the grammar.
In `@packages/documentation/docs/user-guide/further-reading.md`:
- Around line 42-45: The docs currently reference different Visual C++
redistributable versions; determine which VC++ redistributable CasparCG actually
requires (2015 or 2017) and make both mentions consistent: update the text in
further-reading.md (the "Microsoft Visual C++ 2017 Redistributable" link text)
and the CasparCG Server installation guide where it references 2015 so they both
name the confirmed version, and ensure the download URL (vc_redist.x64.exe or
equivalent) points to the correct Microsoft package for that version; search for
other occurrences of "vc_redist" or "Visual C++ 2015/2017" and align those as
well.
In
`@packages/documentation/docs/user-guide/installation/installing-connections-and-additional-hardware/casparcg-server-installation.md`:
- Around line 217-218: Update the Media Scanner Releases link so it points to
the canonical repository; find the markdown line containing the link text "Media
Scanner Releases" and replace the URL
"https://github.com/Sofie-Automation/sofie-media-scanner/releases" with
"https://github.com/CasparCG/media-scanner/releases" so it matches other
references to the CasparCG/media-scanner repo.
packages/documentation/docs/for-developers/contribution-guidelines.md
Outdated
Show resolved
Hide resolved
packages/documentation/docs/for-developers/contribution-guidelines.md
Outdated
Show resolved
Hide resolved
packages/documentation/docs/for-developers/contribution-guidelines.md
Outdated
Show resolved
Hide resolved
.../installation/installing-connections-and-additional-hardware/casparcg-server-installation.md
Outdated
Show resolved
Hide resolved
nytamin
approved these changes
Jan 20, 2026
Member
nytamin
left a comment
nytamin
left a comment
There was a problem hiding this comment.
A good start!
I'm in favor of merging this asap so we can continue discussions on improvements at the next TSC meeting.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
About the Contributor
This pull request is posted on behalf of the Sofie TSC.
Type of Contribution
This is a: Documentation improvement
Current Behavior
Docs refer to old repos / NRK ownership
New Behavior
Docs refer to new repos / Governance ownership
Time Frame
Not urgent, but we would like to get this merged into the in-development release.
Status
Documentation Updates for Organizational Changes
This PR (submitted on behalf of the Sofie TSC) updates the Sofie documentation to reflect the transition from NRK-centric framing to Sofie Governance oversight and broader upstream repository references. PR is a documentation improvement, not yet marked ready for review, and requested to be merged into the in-development release (not urgent).
Key Changes
Branding & Ownership Updates
about-sofie.mdchanged from "NRK Sofie TV Automation System" to "Sofie TV Automation System"contribution-guidelines.mdRepository & Link Updates
nrkno/sofie-casparcg-server) to upstream (CasparCG/server)CasparCG/media-scannerlibraries.mdsupported-devices.mdProcess & Contributor Guidance
contribution-guidelines.mdupdated:Content & Editorial Improvements
sync-ingest-changes.mdabout metaData storage, Piece differentiation (primary,secondary,adlib), and behavior when playStatus ispreviousFiles Modified
packages/documentation/docs/about-sofie.mdpackages/documentation/docs/for-developers/contribution-guidelines.mdpackages/documentation/docs/for-developers/for-blueprint-developers/sync-ingest-changes.mdpackages/documentation/docs/for-developers/libraries.mdpackages/documentation/docs/user-guide/further-reading.mdpackages/documentation/docs/user-guide/installation/installing-connections-and-additional-hardware/casparcg-server-installation.mdpackages/documentation/docs/user-guide/supported-devices.mdpackages/documentation/docusaurus.config.jsImpact
These updates ensure documentation reflects current governance, points to upstream/community repositories, clarifies contributor workflows (including release cadence and RFC/TSC process), and improves clarity for developers and users. Lines changed across docs are small (per-file edits); estimated review effort: medium for larger guideline updates, low for link and wording fixes.