Skip to content

docs: comprehensive documentation overhaul, deployment routing, and navigation improvements - #822

Merged
blue4209211 merged 1 commit into
mainfrom
docs/documentation-overhaul-and-ux-improvements
Aug 20, 2026
Merged

docs: comprehensive documentation overhaul, deployment routing, and navigation improvements#822
blue4209211 merged 1 commit into
mainfrom
docs/documentation-overhaul-and-ux-improvements

Conversation

@blue4209211

Copy link
Copy Markdown
Contributor

Summary of Documentation Overhaul

This PR comprehensively addresses feedback from the installation assessment, section-by-section engineering review, and navigation refinements:

Key Enhancements

  1. Choose Your Deployment Model Router: Rebuilt /docs/installation/ with a SaaS vs. Self-Hosted decision matrix and Kubernetes infrastructure scope clarity.
  2. Server Installation Clarity:
    • Added Components & Why They Exist reference table (PostgreSQL and RabbitMQ as required hard dependencies; Redis optional in-memory fallback; Qdrant/Temporal conditional).
    • Added license and auth key security blast radius callout.
    • Added architectural rationales for network egress, Ingress/SSL, and external databases.
    • Added positive-path verification checklists ("What success looks like").
    • Reclassified default JWT and encryption keys as mandatory to override in production with openssl generation commands.
  3. Agent Installation: Added environment tabs (AWS EKS, GCP GKE, Azure AKS, Local Kind/Minikube), verification steps, and error troubleshooting.
  4. Welcome / Landing Page: Added 2-card "Fork in the Road" setup paths and Core Concepts & Glossary box.
  5. AI & Troubleshooting: Documented NuBi Knowledge Graph reasoning, human-in-the-loop guardrails, and sample CrashLoopBackOff incident walkthrough.
  6. FinOps & Optimizations: Added Right-Sizing calculation mechanics table and GitOps PR workflow.
  7. Workflow Builder: Added variable cheatsheet ({{ steps.<id>.output }}) and 3 production cookbook blueprints.
  8. Integrations: Added least-privilege AWS IAM Policy JSON and BYOM Helm snippets for Ollama, vLLM, Bedrock, and OpenAI.
  9. Security & Telemetry: Added Zero-Telemetry data isolation architecture diagram and Agent read-only Kubernetes ClusterRole RBAC reference.
  10. Dedicated Releases Menu & Navigation Flow:
    • Moved release notes out of nested install paths to a dedicated top-level Releases sidebar menu.
    • Split into Server Releases (GA v1.x root + collapsed pre-1.0 archive), K8s Agent Releases, and Proxy Agent Releases.
    • Positioned FAQ cleanly as the final section in the sidebar.

Verification

  • Tested with npm run build inside doc-server: 0 errors, 0 broken links, 0 broken anchors.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread doc-server/docs/integrations/LLM/index.md
Comment thread doc-server/docs/installation/agent/installation/index.md
Comment thread doc-server/docs/features/optimizations.md
Comment thread doc-server/docs/installation/agent/installation/index.md
Comment thread doc-server/docs/installation/agent/installation/index.md
Comment thread doc-server/docs/installation/agent/installation/index.md
Comment thread doc-server/docs/installation/index.md
@blue4209211
blue4209211 merged commit 3e09eee into main Aug 20, 2026
4 checks passed
@blue4209211
blue4209211 deleted the docs/documentation-overhaul-and-ux-improvements branch August 20, 2026 05:24
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.

3 participants