docs: show a one-command first Vitals report in Quick start
Maintainers usually reply within 9 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 56/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Read the README.md Quick start section, then inspect src/devostasis/cli.py (config_for_repo, cmd_run, and the parser) and docs/deployment.md. Verify the candidate devostasis run --repo drevendev/devostasis --store ./history command from a fresh Python 3.12+ environment at the documented revision. Done means the README shows the tested command, the actual report.md path and first run expectations, while retaining the rate limit and token caveat; confirm the PR target with a maintainer before coding.
Written by the indexing model from the issue text.
Description
Problem
The current README ## Quick start begins with separate devostasis observe and devostasis evaluate commands, then presents the fleet-config devostasis run --config ... flow. For a first-time maintainer, the direct single-repository run that persists a readable report is not shown first. This adds needless steps before the first useful result.
Grounded code path: src/devostasis/cli.py defines run with an exclusive --repo or --config, and --store. The convenience view is described in the README under projects/github.com/<owner>/<repo>/latest/report.md. The command was inspected in source, not yet run in a fresh install.
Desired outcome (one small docs change)
From a clean Python 3.12+ environment, a newcomer can get the first seven Vitals and inspect one Markdown report without creating devostasis.json.
Scope
- In
README.mdQuick start, add a short first-success path using an actually tested invocation (candidate to verify:devostasis run --repo drevendev/devostasis --store ./history). - Point to the actual emitted
report.mdpath after running and briefly state what to expect on the first run (BASELINE vs comparison, unknown API coverage). Keep the explicit rate-limit/token caveat. - Leave observe/evaluate and
--configas documented advanced/reproducible options; do not remove them. - If testing exposes a CLI defect, record it in a separate Issue and stop short of claiming a working doc example.
Non-goals
No CLI/source behavior changes, invented output numbers, PyPI publishing, new dependency, docs restructure, changes to the seven Vitals or release rules.
Acceptance
- Every new command is exercised with a fresh install/checkout at the documented revision; reported path actually exists and contains the seven Vitals (or explicit UNKNOWN where evidence is unavailable).
- Newcomers can copy the first two commands and open the report without guessed configuration.
- Existing
CONTRIBUTING.md/ release-branch policy preserved. Confirm the correct PR target with a maintainer before coding. - Docs diff is small and passes applicable checks. PR reports exactly which tests ran; no unverified installation claims.
Contributor starting points
README.md ("Quick start"); src/devostasis/cli.py (config_for_repo, cmd_run and parser); docs/deployment.md. Test docs example on a public repo without uploading secrets.
Estimated effort: 1–3 hours. Please comment before taking the issue so we can avoid duplicate work.
- Dominant language
- Python
- Stars
- 4
- Forks
- 1
- Avg merge
- 5d 12h
- Merged PRs (30d)
- 3
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from drevendev/Devostasis
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
drevendev/Devostasis#25 ·
Maintainers usually reply within 9 days
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
drevendev/Devostasis#77 ·
Maintainers usually reply within 9 days
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
drevendev/Devostasis#76 ·
Maintainers usually reply within 9 days
-
Offline Git collection: isolate inherited repository context and credential environmentPossibly taken @abogun-product claimed this 12 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 25/100
drevendev/Devostasis#74 ·
Maintainers usually reply within 9 days
-
Difficulty 5/5 Over a week Newbie friendliness 28/100
drevendev/Devostasis#73 ·
Maintainers usually reply within 9 days
All issues in drevendev/Devostasis
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
changelog investigate
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
ramnes/notion-sdk-py#423 ·
-
type-bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day