Skip to content

docs: tell users to run opensre to get started - #6302

Merged
VaibhavUpreti merged 1 commit into
mainfrom
docs/get-started-opensre
Sep 17, 2026
Merged

docs: tell users to run opensre to get started#6302
VaibhavUpreti merged 1 commit into
mainfrom
docs/get-started-opensre

Conversation

@VaibhavUpreti

@VaibhavUpreti VaibhavUpreti commented Sep 17, 2026

Copy link
Copy Markdown
Member

Fixes #

Describe the changes you have made in this PR -

Getting-started docs told people to run opensre setup to sign in. First launch of opensre already opens the account gate, so the user-facing path is now run opensre. opensre setup --dev stays for local webapp work, and opensre integrations setup stays for connecting tools.

Demo/Screenshot for feature changes and bug fixes -

Docs-only. Quickstart/install/README/FAQ now show opensre as the first-run command. Focused docs contract tests pass: uv run pytest tests/cli/test_quickstart.py tests/cli/test_install_readme.py tests/cli/test_install_matrix.py::test_install_docs_list_every_process.

Code Understanding and AI Usage

Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?

  • No, I wrote all the code myself
  • Yes, I used AI assistance (continue below)

If you used AI assistance:

  • I have reviewed every single line of the AI-generated code
  • I can explain the purpose and logic of each function/component I added
  • I have tested edge cases and understand how the code handles them
  • I have modified the AI output to follow this project's coding standards and conventions

Explain your implementation approach:

The product already signs the user in when they run opensre with no subcommand. The docs still prescribed a separate opensre setup step, which duplicated that path and made first run look like a wizard command. I updated the getting-started pages to the command users actually type, left contributor --dev setup and integrations setup alone, and dropped the quickstart contract needle for opensre setup.

Checklist before requesting a review

  • I have added proper PR title and linked to the issue
  • I have performed a self-review of my code
  • I can explain the purpose of every function, class, and logic block I added
  • I understand why my changes work and have tested them thoroughly
  • I have considered potential edge cases and how my code handles them
  • If it is a core feature, I have added thorough tests
  • My code follows the project's style guidelines and conventions

@VaibhavUpreti
Tell new users to run opensre to get started instead of opensre setup.
7f8c665 
Account sign-in already happens on first launch of the shell, so the getting-started docs no longer send people through a separate setup command. Keep opensre setup --dev for local webapp work and opensre integrations setup for connecting tools.
@github-actions

github-actions Bot commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

Greptile code review

This repo uses Greptile for automated review. Before merge, aim for Confidence Score: 5/5 with zero unresolved review threads — see CONTRIBUTING.md.

Run a review — add a PR comment with:

@greptile review

Give it ~5-10 minutes (sometimes longer) for results, then fix feedback and re-trigger until you reach Confidence Score: 5/5.

Optional: automate with the greploop skill.

@VaibhavUpreti
VaibhavUpreti merged commit c8ed2de into main Sep 17, 2026
32 checks passed
@VaibhavUpreti
VaibhavUpreti deleted the docs/get-started-opensre branch September 17, 2026 21:58
@github-actions

github-actions Bot commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

🐉 Legend says enough merged PRs and you ascend. @VaibhavUpreti is dangerously close. 🌤️

👋 Join us on Discord - OpenSRE : hang out, contribute, or hunt for features and issues. Everyone's welcome.

@greptile-apps

greptile-apps Bot commented Sep 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 4/5

The documentation changes appear safe to merge, with one non-blocking weakness in the updated quickstart contract test.

Findings

  1. P2 Command Check Is Too Broad ▶

Summary

This PR updates user-facing onboarding documentation to make bare opensre the recommended first-run command while retaining the dedicated development and integration setup commands.

  • Revises README, installation, quickstart, FAQ, agent, and shell documentation around the sign-in flow.
  • Consolidates sign-in and interactive-shell startup into one documented command.
  • Updates the quickstart contract test, although its new command assertion is too broad to protect the intended step.

Reviews (1) · Last reviewed commit: "Tell new users to run opensre to get sta..."

greptile-apps[bot]
greptile-apps Bot reviewed Sep 17, 2026
View reviewed changes
Comment thread tests/cli/test_quickstart.py
"curl -fsSL https://install.opensre.com | bash",
"irm https://install.opensre.com | iex",
"opensre setup",
"opensre\n",

@greptile-apps greptile-apps Bot Sep 17, 2026

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.

P2 Command check is too broad

The new "opensre\n" check searches the entire document and also matches the Homebrew install lines and a later shell example. The test would therefore keep passing if the first-run command were removed from the “Get started” step, so it no longer protects that onboarding contract. Anchor the check to the command block in that step.

Suggested change
"opensre\n",
" opensre\n ```\n\n The browser opens",

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

Assignees

No one assigned

Labels

size:small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@VaibhavUpreti