Skip to content

Conversation

@briangreunke
Copy link
Contributor

@briangreunke briangreunke commented Sep 19, 2025

Platform usage docs

Key Changes:

  • moved self-hosted platform docs into "usage" path

Added:

  • platform cmd docs

Generated Summary:

  • Added a new "Platform" group in the documentation navigation with the following links for self-hosted platform resources:
    • Overview
    • Install
    • Quickstart
    • Usage
    • Advanced Usage
    • Commands
    • Configure
    • Environment
    • Versioning
    • FAQ
    • Troubleshooting
  • Introduced new documentation files for the following topics:
    • Advanced Usage: Covers configuration for advanced deployment scenarios including remote databases and ClickHouse clusters.
    • Command Reference: Lists all platform CLI commands and their options.
    • Configure: Explains how to set persistent configuration for the platform and use one-off overrides.
    • Environment & Files: Describes where key files are located and how environment variables are generated and merged.
    • FAQ: Answers common questions related to the platform usage.
    • Install: Details requirements and installation steps for the Dreadnode SDK.
    • Overview: Provides a high-level description of the self-hosted Dreadnode platform.
    • Quickstart: Steps to get started with the platform.
    • Troubleshooting: Common issues and solutions for platform management.
    • Versioning & Architectures: Information on supported architectures and how version tags are resolved.
  • Potential impact:
    • Users will have clearer guidance on deploying and managing the self-hosted platform.
    • Enhanced resource access may simplify onboarding and troubleshooting for new users.

This summary was generated with ❤️ by rigging

@dreadnode-renovate-bot dreadnode-renovate-bot bot added area/docs Changes to documentation and guides type/docs Documentation updates and improvements labels Sep 19, 2025
@briangreunke briangreunke marked this pull request as ready for review September 19, 2025 13:55
@briangreunke briangreunke merged commit e5851e5 into main Sep 19, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Changes to documentation and guides type/docs Documentation updates and improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants