Skip to content

Align the README with the console, CLI, and finding scores - #84

Merged
om986 merged 1 commit into
mainfrom
docs/readme-first-run
Oct 13, 2026
Merged

om986 merged 1 commit into
mainfrom
docs/readme-first-run

Conversation

@om986

@om986 om986 commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Tell the quick start to paste change-me-in-production into the console API key field before the graph will load.
  • Describe finding scores as base severity plus internet reachability, a path to a datastore, and admin access.
  • Shorten the repeated Phase 3 status, list the graph and paths commands, and note that the CLI does not read .env.

Test plan

  • Read the quick start and confirm the API key step matches .env.example and the console Save API key button.
  • Confirm the score description matches GraphContext.ScoreBoost (internet reachability, path to a datastore, admin access).
  • Confirm graph and paths are real om commands.

Made with Cursor

A first run was missing the API key step, and the score description included blast radius and path length.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Oct 12, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: Repository: OpenSourceOM/core/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 187e9b95-d369-41e4-aedf-8d61cb6336cc
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@om986
om986 merged commit 5a657ba into main Oct 13, 2026
6 of 7 checks passed
@om986
om986 deleted the docs/readme-first-run branch October 13, 2026 00:29
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.

1 participant