Skip to content

Chore: Fix broken links#171

Merged
amotl merged 3 commits intomainfrom
broken-links-2026-01
Jan 21, 2026
Merged

Chore: Fix broken links#171
amotl merged 3 commits intomainfrom
broken-links-2026-01

Conversation

@amotl
Copy link
Member

@amotl amotl commented Jan 21, 2026

Just maintenance.

@coderabbitai
Copy link

coderabbitai bot commented Jan 21, 2026

Walkthrough

A comprehensive repository migration from Panodata to Tech Writing organization, featuring URL/link updates across documentation and tests, organization metadata changes, copyright year updates to 2026, and a new GitHub Actions workflow for documentation link checking with Sphinx configuration adjustments.

Changes

Cohort / File(s) Summary
CI/CD & Build Configuration
.github/workflows/docs.yml, pyproject.toml
Added new GitHub Actions workflow for documentation link checking; enhanced build configuration with explicit HTML builder and new linkcheck builder task; updated repository URLs from panodata to tech-writing
Metadata & Configuration
docs/conf.py, CHANGES.md
Updated copyright year to 2026 and author from "Panodata Developers" to "Tech Writing Developers"; added link checker ignore rules and anchor configuration; updated changelog reference formatting
Documentation Content
README.md, docs/backlog.md, docs/css_classes.md, docs/get_started.md, docs/infocard.md, docs/sandbox.md, docs/snippets/myst/infocard.md, docs/snippets/rst/infocard.rst
Updated repository URLs and links from panodata to tech-writing; changed example URLs from beagles subdomain to root domain; updated author attribution and badge URLs to static CDN
Test Expectations & Examples
tests/test_hyper.py, tests/test_snippets/snippet_myst_*.xml, tests/test_snippets/snippet_rst_*.xml
Aligned test expectations and XML snippets with updated example URLs and link references; changed expected values from "Example Domain" text to https://example.org URLs

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A bunny hops through code with glee,
From Panodata to Tech Writing spree!
Links now point where rabbits roam,
New docs checker calls them home,
Twenty-twenty-six shines bright,
All the URLs now right! 🌟

🚥 Pre-merge checks | ✅ 1 | ❌ 2
❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Description check ❓ Inconclusive The description 'Just maintenance.' is vague and generic, using non-descriptive terminology that doesn't convey meaningful information about the specific changes made. Expand the description to explain what maintenance work is being performed, such as 'Fix broken links in documentation and update repository references following organization name change.'
✅ Passed checks (1 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Chore: Fix broken links' clearly and concisely describes the main objective of the changeset, which is fixing broken links across documentation and configuration files.

✏️ 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 broken-links-2026-01

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.

@amotl amotl force-pushed the broken-links-2026-01 branch from dfdecf8 to 5735772 Compare January 21, 2026 04:37
@codecov
Copy link

codecov bot commented Jan 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.78%. Comparing base (d432e99) to head (1765bbf).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #171   +/-   ##
=======================================
  Coverage   94.78%   94.78%           
=======================================
  Files          10       10           
  Lines         594      594           
=======================================
  Hits          563      563           
  Misses         31       31           
Flag Coverage Δ
unittests 94.78% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@amotl amotl force-pushed the broken-links-2026-01 branch 3 times, most recently from 2fb1d58 to 1765bbf Compare January 21, 2026 04:53
@amotl amotl marked this pull request as ready for review January 21, 2026 04:53
@amotl amotl merged commit f4a9a5d into main Jan 21, 2026
16 checks passed
@amotl amotl deleted the broken-links-2026-01 branch January 21, 2026 04:58
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