Skip to content

docs: correct pages that drifted from the product - #908

Merged
blue4209211 merged 1 commit into
mainfrom
docs/proofread-fixes
Oct 25, 2026
Merged

blue4209211 merged 1 commit into
mainfrom
docs/proofread-fixes

Conversation

@blue4209211

@blue4209211 blue4209211 commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Corrects 130 pages whose text no longer matches the product. Each page was read against the current UI and code. Every change was then re-checked twice by separate passes: added lines against the code, then removed content, cross-page contradictions and copy-paste correctness.

What changed, by area

  • Installation
    • Agent upgrade commands now use --reuse-values. Without it, they reset the agent's auth key.
    • Proxy-agent config examples now use the datasource types Forager loads.
    • Installer pipes now use sudo.
    • ClickHouse pod, PVC and job names are now the real ones.
    • The node-agent kernel requirement is now 5.8, or a kernel that backports BPF ring buffers.
  • Integrations
    • In K8s mode, a bare secret name is looked up in the agent's namespace.
    • Save stays disabled until Test Connection passes.
    • A bad webhook token returns 400.
    • Fixed the severity mappings for Datadog, Dynatrace, SolarWinds, GCP, New Relic and ZenDuty.
    • Updated the Discord, Google Chat, MCP, SAML and API-token flows.
    • Greyed-out providers are now marked unavailable.
  • Automations
    • Loop items use {{ LoopItem.item }}, and tasks are ordered with depends_on.
    • Commands need their gh, glab and rabbitmqadmin prefixes.
    • The Approval step is limited by the task and automation timeouts.
    • The lifecycle phase (params.on) is set in the workflow definition.
    • Added the list of tasks that honour Dry Run.
  • Troubleshooting / K8s / Cloud / AI
    • Workflows fire at event creation by default.
    • Updated triage scoring for new kinds of alert.
    • Fixed the cloud fleet onboarding paths.
    • Fixed SLO, Optimize and Agent Health labels.
    • Fixed the AI assistant and agent names, and the egress-filter defaults.
    • FAQ: retention and knowledge sources.

How to verify

  1. CI build passes. The site builds with no broken links or anchors.
  2. Spot-check a few pages against the app:
    • Admin → Integrations → Kubernetes & Cloud → AWS → AWS Organization should match features/Cloud/cloud-fleet-onboarding.md.
    • Troubleshoot → All Events should match the webhook "verify" steps.
    • The API Tokens page (user menu) should match features/api-tokens.md.

🤖 Generated with Claude Code

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

Copy link
Copy Markdown
Contributor

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 comprehensively updates the NudgeBee documentation to align with recent product updates, feature enhancements, and configuration changes. Key updates include simplifying the API token authentication flow to use direct Bearer tokens (removing the JWT exchange step), introducing 'Account Type' (Production vs. Non-production) settings for cloud integrations, detailing granular RBAC permissions for AI features, and documenting new workflow triggers based on event lifecycle phases. Additionally, the documentation adds support for new integrations like ZenDuty, Freshdesk, LDAP, and Teleport, updates the agent installation requirements to specify Linux kernel 5.8 or newer (due to BPF ring-buffer requirements), and refines the configuration guides for the Forager proxy agent and various webhook targets. As there are no review comments, no further feedback is provided.

Proofread every page added in the recent docs sweep against the current
UI and code, and fixed the statements that no longer match: menu paths
and button labels, defaults and limits, task parameter names, webhook
severity mappings, and commands that fail as written (helm upgrades
without --reuse-values, proxy-agent datasource types, installer pipes
without sudo, ClickHouse pod names).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: shiv <blue.4209211@gmail.com>
@blue4209211
blue4209211 merged commit 97b40ad into main Oct 25, 2026
4 checks passed
@blue4209211
blue4209211 deleted the docs/proofread-fixes branch October 25, 2026 16:13
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