Skip to content

Docs/fix setup instructions - #180

Merged
iansargent merged 4 commits into
VERSO-UVM:mainfrom
EZRocketSurgery:docs/fix-setup-instructions
Nov 10, 2026
Merged

iansargent merged 4 commits into
VERSO-UVM:mainfrom
EZRocketSurgery:docs/fix-setup-instructions

Conversation

@EZRocketSurgery

Copy link
Copy Markdown
Contributor

What was wrong

  • CLAUDE.md L28-L30 listed backend commands that no longer work:
    • pip install -r requirements.txt: the repo has no requirements.txt. Dependencies are in backend/pyproject.toml and uv.lock, and the root README installs them with uv sync.
    • streamlit run Home.py: backend/Home.py doesn't exist, and streamlit isn't in pyproject.toml or uv.lock.
    • uvicorn ... had no uv run prefix. CLAUDE.md's own tip on L11 says to use uv run, and so does the justfile's local-api recipe.
  • docs/README.md L3 linked to codebase_primer.md, but the file is docs/Codebase_Primer.md. The link works on Windows and macOS, which ignore case in file names, but gives a 404 on GitHub and Linux.

What changed

  • b0f97ed: the link target is now Codebase_Primer.md. The file itself isn't renamed.
  • c31e727: in CLAUDE.md, pip install -r requirements.txt becomes uv sync, the uvicorn command gets the uv run prefix, and the Streamlit line is removed.

Docs only: 2 files, +3/−4.

How I verified it

  • Confirmed that backend/requirements.txt and backend/Home.py don't exist, and that streamlit doesn't appear in pyproject.toml or uv.lock.
  • Searched the repo for requirements.txt, Home.py and codebase_primer (ignoring case). Nothing stale remains. README.md L5 already used the correct docs/Codebase_Primer.md.
  • Ran prettier --check with the repo's Prettier 3.9.4:
    • CLAUDE.md passes.
    • docs/README.md was already failing on main because of the table padding, a blank line and a trailing space. This PR doesn't touch those lines, so it doesn't fix them or make them worse.

For maintainers to decide (not in this PR)

  1. Rename Codebase_Primer.md to codebase_primer.md. That would follow the convention at docs/README.md L18 ("File names are lowercase snake_case.md"). The rename would also need the links in README.md L5 and docs/README.md L3 updated. I'm happy to open a follow-up PR if you want it.
  2. Prettier on docs/README.md. It doesn't pass the formatting rule at L22. The pre-commit config only runs Prettier on frontend/**/*.ts(x), so markdown isn't checked automatically. I can include that fix in the same follow-up.

🤖 Generated with Claude Code

EZRocketSurgery and others added 2 commits November 5, 2026 19:49
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment thread docs/README.md Resolved

@iansargent iansargent left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Charles,

Thank you for taking the time for edits! These changes are perfect for ensuring our documentation is updated is not going stale. We switched over to uv a while ago and the streamlit references our first prototype build of the site.

Anyways, I hope to see more PRs from you!

Happy coding,
Ian

@EZRocketSurgery

Copy link
Copy Markdown
Contributor Author

Charles,

Thank you for taking the time for edits! These changes are perfect for ensuring our documentation is updated is not going stale. We switched over to uv a while ago and the streamlit references our first prototype build of the site.

Anyways, I hope to see more PRs from you!

Happy coding, Ian

Ian,

Thanks so much for the warm welcome! I'm planning on exploring some data from The U.S. Energy Information Administration and see if I can't get it cleaned to y'all's standards as time permits. It should be a very rich source of energy, emissions, and fuel data.

@iansargent iansargent left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks!

@iansargent
iansargent merged commit f7f938e into VERSO-UVM:main Nov 10, 2026
2 checks passed
@EZRocketSurgery
EZRocketSurgery deleted the docs/fix-setup-instructions branch November 12, 2026 03:02
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.

2 participants