Skip to content

fix: align navigation checks and move OAuth docs to /oauth - #255

Merged
egelhaus merged 2 commits into
mainfrom
fix/check-docs-tab-prefixes
Oct 7, 2026
Merged

egelhaus merged 2 commits into
mainfrom
fix/check-docs-tab-prefixes

Conversation

@giladresisi

@giladresisi giladresisi commented Oct 7, 2026 •

Copy link
Copy Markdown
Collaborator

The navigation uses the Agents and Add Postiz to your app tabs, but the documentation checker still expected Automation and had no rule for the app tab. This caused structure checks to fail whenever a PR touched docs.json.

Update the checker to recognise Agents with the existing cli/ and mcp/ prefixes. Move OAuth documentation from /public-api/oauth to /oauth, update its navigation entry and all incoming documentation links, and give Add Postiz to your app its own oauth prefix rule. A permanent redirect preserves existing links to /public-api/oauth.

Validation: npm run check and npm run check:changed pass across all 182 documentation files; git diff --check passes.

Summary by CodeRabbit

  • Documentation
    • Updated OAuth-related links across the developer, MCP, and public API guides to use the /oauth address.
    • Added a permanent redirect from the previous OAuth documentation address to /oauth, so existing links continue to work.
    • Updated the OAuth2 navigation entry to point to the new address.

docs.json renamed the Automation tab to Agents and added the Add Postiz to
your app tab, but tabPrefixes in check-docs.mjs still listed Automation, so
any PR that touches docs.json failed the structure check with "tab has no
path prefix rule" (main itself fails the full check).

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@giladresisi
giladresisi requested a review from egelhaus as a code owner October 7, 2026 02:52
@postiz-contribution postiz-contribution Bot added the contribution:approved Approved contributor label Oct 7, 2026
@coderabbitai

coderabbitai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 5ddd8ba3-0540-496e-bd95-5bdb23d530ba
📥 Commits

Reviewing files that changed from the base of the PR and between 4256b10 and 337691d.

📒 Files selected for processing (6)
  • docs.json
  • general/settings/developers.mdx
  • mcp/introduction.mdx
  • oauth.mdx
  • public-api/introduction.mdx
  • scripts/check-docs.mjs

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

OAuth documentation links now use /oauth, with a permanent redirect from /public-api/oauth. The docs checker’s path-prefix mapping and cross-listing comment now refer to the Agents tab.

Changes

OAuth documentation paths

Layer / File(s) Summary
OAuth route and links
docs.json, general/settings/developers.mdx, mcp/introduction.mdx, public-api/introduction.mdx
The OAuth navigation entry and documentation links point to /oauth. A permanent redirect maps /public-api/oauth to /oauth.

Agents tab path mapping

Layer / File(s) Summary
Agents path-prefix mapping
scripts/check-docs.mjs
The path-prefix mapping and cross-listing comment refer to the Agents tab instead of Automation.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 33769

The legacy OAuth URL redirects to the moved guide, updated links and navigation point to it, and the checker’s OAuth and Agents prefix rules match the navigation. No merge-blocking issue is evident.

Architecture Summary

Architecture risk: 🔵 Low · up to 33769

The change affects 5 systems.

Changed systems: scripts, docs.json, general, mcp, public-api

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — scripts (service) was modified; 1 changed file maps to changed impact.
  • observed — docs.json (service) was modified; 1 changed file maps to changed impact.
  • observed — general (service) was modified; 1 changed file maps to changed impact.
  • observed — mcp (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs.json: Adds a permanent redirect from /public-api/oauth to /oauth.
  • observed — Modified behavior in docs.json: The OAuth2 navigation entry now points to oauth instead of public-api/oauth.
  • observed — Modified behavior in general/settings/developers.mdx: The OAuth guide link changes from /public-api/oauth to /oauth.
  • observed — Modified behavior in mcp/introduction.mdx: The OAuth2 link target changes from /public-api/oauth to /oauth.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the navigation-check updates and the move of OAuth documentation to /oauth.
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@postiz-agent

postiz-agent Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@egelhaus egelhaus changed the title fix: add Agents and Add Postiz to your app tabs to check-docs fix: align navigation checks and move OAuth docs to /oauth Oct 7, 2026
@egelhaus
egelhaus merged commit 16bff82 into main Oct 7, 2026
9 checks passed
@egelhaus
egelhaus deleted the fix/check-docs-tab-prefixes branch October 7, 2026 04:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution:approved Approved contributor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants