docs: promote Supporting Services to GA and fix mkdocs warnings#375
docs: promote Supporting Services to GA and fix mkdocs warnings#375
Conversation
📝 WalkthroughWalkthroughThis PR promotes Supporting Services from beta status to generally available. Documentation is updated to reflect the new terminology and GA status, including removal of beta labels, addition of new service documentation pages (RAG and PostgREST), and clarification about systemd cluster support limitations. Changes
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Review rate limit: 4/5 reviews remaining, refill in 12 minutes. Comment |
Up to standards ✅🟢 Issues
|
| @@ -1,32 +1,5 @@ | |||
| # Running the Control Plane locally | |||
|
|
|||
| - [Running the Control Plane locally](#running-the-control-plane-locally) | |||
There was a problem hiding this comment.
Do we have to remove this? I think most people will consume this document in their editor or in GitHub rather than our docs site, and I find the TOC really helpful for navigating it.
There was a problem hiding this comment.
I'd also be open to removing all of our development docs from the docs site.
There was a problem hiding this comment.
Both Github and VS Code have outline views for viewing the table of contents, so it seemed like a consistent experience across all three places to just remove this. Obviously not every editor will have an outline view / markdown navigation features.
I think having the development docs on the docs site is valuable - it promotes the idea of outside contribution.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
mkdocs.yml (1)
51-100:⚠️ Potential issue | 🔴 CriticalRemove or replace the non-existent "redoc-tag" plugin in mkdocs.yml.
The
mkdocs build --strictcommand fails withERROR - Config value 'plugins': The "redoc-tag" plugin is not installed. There is no PyPI package providing this plugin. The configuration references a plugin that cannot be resolved, preventing the documentation from building at all. Either remove the plugin reference from mkdocs.yml (line 18) if it's no longer needed, or replace it with the correct plugin name/package.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@mkdocs.yml` around lines 51 - 100, The mkdocs build fails because mkdocs.yml references a non-existent plugin "redoc-tag" under the plugins key; open mkdocs.yml, locate the plugins section and either remove the "redoc-tag" entry or replace it with the correct plugin name/package (or a supported redoc plugin) so mkdocs can resolve plugins during mkdocs build --strict; ensure the plugins list is valid and run the build to confirm the error is gone.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@mkdocs.yml`:
- Around line 51-100: The mkdocs build fails because mkdocs.yml references a
non-existent plugin "redoc-tag" under the plugins key; open mkdocs.yml, locate
the plugins section and either remove the "redoc-tag" entry or replace it with
the correct plugin name/package (or a supported redoc plugin) so mkdocs can
resolve plugins during mkdocs build --strict; ensure the plugins list is valid
and run the build to confirm the error is gone.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b0142d55-69ce-4c1c-98d7-dd10181f095b
📒 Files selected for processing (6)
Makefilechanges/unreleased/Changed-20260501-104640.yamldocs/development/running-locally.mddocs/development/supported-services.mddocs/services/index.mdmkdocs.yml
💤 Files with no reviewable changes (1)
- docs/development/running-locally.md
2 participants
Summary
service dev guide to mkdocs nav