This repository was archived by the owner on Feb 26, 2026. It is now read-only.
Conversation
Signed-off-by: fbugarski <filipbugarski@gmail.com>
Signed-off-by: fbugarski <filipbugarski@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR restructures the Docusaurus documentation into separate User Guide and Dev Guide sections to address issue #66, updating sidebar organization and adjusting doc content/links accordingly.
Changes:
- Reworked
sidebars.tsto split navigation into User Guide and Dev Guide trees. - Moved/renamed doc references and updated internal links to match the new doc layout.
- Added new documentation content (RBAC roles doc, auth/request-flow doc, routes API doc) and a fine-tuning notebook.
Reviewed changes
Copilot reviewed 28 out of 32 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.ts | Splits the sidebar into User Guide vs Dev Guide categories and updates doc IDs/paths. |
| docs/index.md | Removes redundant headings while keeping id: intro as the entry doc. |
| docs/user/getting-started.md | Adjusts content structure and updates link to developer integrations. |
| docs/user/guardrails.md | Removes redundant heading to align with page title/frontmatter. |
| docs/user/ui/overview.md | Removes redundant heading and updates link to the new developer Chat UI doc path. |
| docs/user/ui/domains.md | Removes redundant heading to align with page title/frontmatter. |
| docs/user/ui/user-actions.md | Wraps a long note line for formatting consistency. |
| docs/user/security/roles-and-access-control.md | Adds new RBAC roles/access control documentation for users. |
| docs/user/security/audit-logs.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/architecture.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/platform/vllm.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/attestation.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/auth/pats.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/api/overview.md | Updates guardrails link to the new user docs location. |
| docs/developer/api/authentication.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/api/chat-completions.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/api/completions.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/api/embeddings.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/api/models.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/api/speech-to-text.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/api/translations.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/api/routes.md | Adds new Routes Management API documentation. |
| docs/developer/integrations/continue.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/integrations/opencode.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/guide/index.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/guide/chat-ui.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/guide/private-model-upload.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/guide/hal.md | Updates internal links from old /developer-guide/... to /developer/guide/.... |
| docs/developer/guide/cvm-management.md | Updates internal links from old /developer-guide/... to /developer/guide/.... |
| docs/developer/guide/fine-tuning.md | Removes redundant heading to align with page title/frontmatter. |
| docs/developer/guide/auth-and-request-flow.md | Adds new auth & request flow doc (diagram + step list). |
| docs/developer/notebooks/Fine_Tuning_Qwen_2.5_Coder_1.5b.ipynb | Adds a fine-tuning notebook (Colab-style workflow). |
Comments suppressed due to low confidence (1)
docs/developer/api/overview.md:84
- The link text says "Guardrails Developer Guide" but it points to the user guide path (../../user/guardrails). Consider renaming the link text to match the destination (e.g., "Guardrails" / "AI Guardrails") or moving this doc under developer docs if it’s meant to be developer-focused.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
SammyOina
suggested changes
Feb 24, 2026
| Additionally, all requests pass through the **Guardrails Service** for input validation | ||
| and output sanitization. See the | ||
| [Guardrails Developer Guide](../guardrails.md) for details. | ||
| [Guardrails Developer Guide](../../user/guardrails) for details. |
Contributor
There was a problem hiding this comment.
"developer guide" but points to user docs
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
resolve: #66