Skip to content

Updated "Get Started in 5 Minutes" docs - #30

Merged
EthanRBrown merged 1 commit into
mainfrom
doc-changes
Nov 3, 2025
Merged

Updated "Get Started in 5 Minutes" docs#30
EthanRBrown merged 1 commit into
mainfrom
doc-changes

Conversation

@EthanRBrown

Copy link
Copy Markdown
Contributor

This reflects changes made in commit 3151287 (Sep 26).

This reflects changes made in commit 3151287 (Sep 26).
@EthanRBrown
EthanRBrown requested a review from lazamar November 3, 2025 22:25

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread README.md
Comment on lines 35 to +39
# linux or mac
./dev_start.sh
./dev_demo.sh
./start.sh

# windows
.\dev_start.ps1
.\dev_demo.ps1
.\start.ps1

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Provide executable Windows startup command

The setup instructions now tell Windows users to run .\start.ps1, but the repository does not contain any PowerShell scripts (git ls-files | grep '.ps1' returns nothing). Following the README will therefore fail on Windows because there is no script to invoke. Either add a PowerShell variant or update the docs to point to an existing script (e.g. via WSL).

Useful? React with 👍 / 👎.

@lazamar lazamar 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.

Nice. This repo will change a little, and all these different scripts were from past incarnations of this code.
Thanks for the update.

For the future we will just have a utils.sh script in this project like we do in the virtual-agent repo.

@EthanRBrown
EthanRBrown merged commit 82a9bd4 into main Nov 3, 2025
1 check passed
@EthanRBrown
EthanRBrown deleted the doc-changes branch November 3, 2025 23:38
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