Skip to content

docs: update Quick Start instructions in README - #711

Merged
chrispcampbell merged 10 commits into
mainfrom
travis/start-up-help-edits
Aug 14, 2026
Merged

docs: update Quick Start instructions in README#711
chrispcampbell merged 10 commits into
mainfrom
travis/start-up-help-edits

Conversation

@travisfranck

@travisfranck travisfranck commented Dec 11, 2025

Copy link
Copy Markdown
Collaborator

Fixes #886

Edits to README to add some clarification to the steps that I found confusing or have slightly changed. Reordered one section to help with the flow.

@travisfranck

travisfranck commented Mar 12, 2026

Copy link
Copy Markdown
Collaborator Author

Changes to the README from my testing in December. I merged with the latest from main so should be easy.

@chrispcampbell

Copy link
Copy Markdown
Contributor

@travisfranck: The reason I hadn't done anything with this yet is that I needed to consider it in the context of some other doc improvements I had planned. To be clear, not ignoring it, I just need time for that but have been busy with other work.

@travisfranck

Copy link
Copy Markdown
Collaborator Author

@chrispcampbell No problem! I was updating my git repo and thought I forgot to submit this formally. I'm done submitting to this PR unless you'd like changes (when you get to it).

@chrispcampbell chrispcampbell changed the title Updated Quick Start instructions docs: update Quick Start instructions in README Aug 14, 2026

@chrispcampbell chrispcampbell left a comment

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.

I made some edits (see individual commits listed in this PR) but overall the structural changes make sense. Thanks for submitting.

@chrispcampbell
chrispcampbell merged commit acd90e9 into main Aug 14, 2026
7 checks passed
@chrispcampbell
chrispcampbell deleted the travis/start-up-help-edits branch August 14, 2026 23:10
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.

Improve Quick Start instructions in top-level README

2 participants