Skip to content

docs: Fix broken doc links#1632

Open
PeterC89 wants to merge 1 commit intomainfrom
docs/fix-docs
Open

docs: Fix broken doc links#1632
PeterC89 wants to merge 1 commit intomainfrom
docs/fix-docs

Conversation

@PeterC89
Copy link
Contributor

@PeterC89 PeterC89 commented Feb 4, 2026

About the Contributor

This pull request is opened on behalf of the TSC

Type of Contribution

This is a: Bug fix / Documentation improvement

Current Behavior

Docs don't build

New Behavior

Docs build

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

This bug fix needs to be merged into 26.03

Other Information

Status

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

Documentation Link Fixes

This PR fixes broken documentation links by adding and correcting documentation files to restore the build process for the Sofie Core documentation site.

Changes

packages/documentation/docs/user-guide/configuration/settings-view.md (new file, 202 lines)

  • Comprehensive documentation for the Settings View covering System, Studio, and Show Style configuration sections
  • Documents system-wide settings including notification messages, support panels, action triggers, monitoring, and CRON jobs
  • Details Studio settings for attached devices, blueprint configuration, and layer mappings
  • Explains Show Style configuration including source layers, output channels, action triggers, and blueprint configuration
  • Provides guidance on route sets, exclusivity groups, and AB channel display settings
  • Includes complete documentation of action triggers and shift register modifications for advanced use cases

packages/documentation/docs/user-guide/installation/installing-a-gateway/input-gateway.md (new file, 53 lines)

  • Input Gateway installation and configuration documentation with command-line argument reference
  • Documents supported devices and protocols (Stream Deck, Skaarhoj, X-Keys, MIDI, OSC, HTTP)
  • Explains Input Gateway-specific features including Shift Registers for pagination and combination inputs
  • Describes AdLib Tally functionality for visual feedback on playout state
  • Includes properly corrected relative documentation links:
    • Package Manager reference: ../installing-package-manager.md
    • CasparCG Launcher reference: ../installing-connections-and-additional-hardware/casparcg-server-installation#installing-the-casparcg-launcher
    • Action Triggers cross-references: ../../configuration/settings-view.md#actions

Impact

Restores documentation build functionality by adding complete, properly linked documentation files. Users now have comprehensive reference material for configuration and installation procedures with correct cross-references.

  • Lines changed: +255
  • Type: Documentation / Bug fix
  • No code or public API modifications

@PeterC89 PeterC89 requested a review from a team as a code owner February 4, 2026 14:00
@coderabbitai
Copy link

coderabbitai bot commented Feb 4, 2026

Walkthrough

Documentation files updated with corrected relative paths for internal links and minor text formatting cleanups across the installation and configuration guide sections.

Changes

Cohort / File(s) Summary
Documentation Link Updates and Cleanups
packages/documentation/docs/user-guide/configuration/settings-view.md, packages/documentation/docs/user-guide/installation/installing-a-gateway/input-gateway.md
Corrected internal documentation link paths to reflect reorganized directory structure; updated Device Triggers input gateway reference and Package Manager/CasparCG Launcher references. Minor text formatting adjustments and trailing space removal.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 With whiskers twitching, I hop through the docs,
Fixing each link like unlocking the locks,
Paths rearranged, but the content stays true,
A tidy refactor, now shiny and new! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: Fix broken doc links' directly and concisely summarizes the main change—fixing broken documentation links across multiple files in the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/fix-docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Feb 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 4, 2026

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.

1 participant