Skip to content

docs: restore course-init and clarify getting started - #11

Closed
crymarch wants to merge 1 commit into
mainfrom
docs/getting-started-refresh
Closed

crymarch wants to merge 1 commit into
mainfrom
docs/getting-started-refresh

Conversation

@crymarch

Copy link
Copy Markdown
Contributor

Summary

  • Restore course-init.sh for this template (REPLACEREPONAME replace, lab variant selection, clear error when --type bfx lacks modules.bfx)
  • Rewrite README with Quick Course / Open Training audience notes and --type hol as the recommended default
  • Fix DEVSPACE.md with the real Dev Spaces base URL and clearer steps
  • Bump template-version.txt to 1.0.2

Test plan

  • Fresh clone of this branch; run zsh course-init.sh --type hol --lab demo in a throwaway copy and confirm REPLACEREPONAME is replaced and lab index is set
  • Confirm --type bfx exits with a clear error when modules.bfx/ is absent
  • Spot-check DEVSPACE URL pattern and README-TRAINING Contribute badge still use REPLACEREPONAME until init

Notes

Draft for PERT review — please do not merge until approved.

Add an adapted course-init.sh that replaces REPLACEREPONAME, selects lab variants, and fails clearly when --type bfx lacks modules.bfx. Refresh README and DEVSPACE with the real Dev Spaces URL and hol-first init guidance.

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions

github-actions Bot commented Jul 29, 2026 •

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-07-29 19:16 UTC

@crymarch crymarch closed this Jul 29, 2026
@crymarch
crymarch deleted the docs/getting-started-refresh branch July 29, 2026 19:16
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.

1 participant