Skip to content

Docs : Topic based organization for documentation #620

@Shaik-Sirajuddin

Description

@Shaik-Sirajuddin

MCP server hosts variety of tools , for users to choose from
A user is likely to configure some of tools for their specific purpose

With each tool having its own documented content ,
trying to navigate through specific categories makes it frictional from a single ReadMe File

A topic based organization , possibly hosted alongside index of official grafana docs will make it easier to navigate
Grafana docs mentions Writers Tool Kit for Technical Documentation Guide with tools to apply lint checks , build site for docs

Prposed Approach :
Documentation reorganized at docs folder with existing content

  • Tools
    • Admin
    • Datasources
      • Prometheus
      • Tempo
      • Loki
  • Dashboards
    or a similar

Makes it easier for users to get an overview , deepdive into an specifc topic

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions