docs: first-run path — install to first useful reading

Open
#959 0 comments 0 reactions 1 assignee View on GitHub

@mrsabath is already working on this.

Since Sep 10, 2026.

Assessment

This issue has not been assessed yet.

Description

documentation high priority
Feature Description

The README leads with the local-tool story well. Below it, the docs are organised around the
platform — plugin catalog, plugin contracts, Kubernetes, SPIFFE — rather than around a person
installing Cortex on a laptop for the first time.

Proposed Solution
  • One path that works start to finish: install → observe → read the numbers → stop/remove
  • Real output shown, not paraphrased
  • Every command verified against v0.9.0
  • Links out to the new surfaces rather than duplicating them

Each feature issue documents its own surface; this is the spine that connects them.

Additional Context

Part of the Cortex v0.9.0 release. Out of scope: platform doc corrections #856, #671, #740.

Dominant language
Go
Stars
13
Forks
40
Avg merge
12h 17m
Merged PRs (30d)
156

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rossoctl/cortex

All issues in rossoctl/cortex

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.