docs: comprehensive documentation overhaul, deployment routing, and navigation improvements - #822
Merged
blue4209211 merged 1 commit intoAug 20, 2026
Conversation
…avigation improvements
RamanKharchee
approved these changes
Aug 20, 2026
mayankpande88
approved these changes
Aug 20, 2026
There was a problem hiding this comment.
Code Review
This pull request significantly enhances and restructures the NudgeBee documentation, adding detailed guides on system requirements, data isolation architecture, agent RBAC permissions, GitOps workflows, and troubleshooting. The review feedback is highly constructive and should be fully addressed: it recommends replacing non-standard LaTeX math syntax ($\rightarrow$) with standard unicode arrows (→) across several files to ensure consistent rendering in Docusaurus, adding a missing Prometheus installation step to the GCP GKE setup tab, and clarifying the usage of bare model IDs for AWS Bedrock on-demand inference.
blue4209211
deleted the
docs/documentation-overhaul-and-ux-improvements
branch
August 20, 2026 05:24
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary of Documentation Overhaul
This PR comprehensively addresses feedback from the installation assessment, section-by-section engineering review, and navigation refinements:
Key Enhancements
/docs/installation/with a SaaS vs. Self-Hosted decision matrix and Kubernetes infrastructure scope clarity.opensslgeneration commands.CrashLoopBackOffincident walkthrough.{{ steps.<id>.output }}) and 3 production cookbook blueprints.ClusterRoleRBAC reference.Verification
npm run buildinsidedoc-server: 0 errors, 0 broken links, 0 broken anchors.