Skip to content

Update README for the main branch and document the serve command - #30

Merged
ziflex merged 2 commits into
mainfrom
copilot/update-readme-documentation
Apr 4, 2026
Merged

Update README for the main branch and document the serve command#30
ziflex merged 2 commits into
mainfrom
copilot/update-readme-documentation

Conversation

Copilot AI commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

README still referenced master in a few GitHub-hosted asset and installer URLs, which breaks or misroutes documentation for the current default branch. This updates those links to main so branch-specific docs assets resolve correctly, and adds missing documentation for the standalone serve command.

  • Branch-specific GitHub URLs

    • Switched the Codecov badge URL from branch/master to branch/main
    • Updated the landing image URL to load from main
    • Updated the install command to fetch install.sh from main
  • Serve command documentation

    • Added a feature callout for the dedicated lab serve command
    • Added a short standalone usage example showing how to serve one or more directories without running tests
  • Documentation impact

    • Keeps copy-paste install instructions aligned with the current default branch
    • Prevents branch drift in externally hosted README assets
    • Makes the new static file serving workflow discoverable in the README
curl -fsSL https://raw.githubusercontent.com/MontFerret/lab/main/install.sh | sh

lab serve ./website
lab serve ./frontend@app ./mockdata@api

Agent-Logs-Url: https://github.com/MontFerret/lab/sessions/0cfec7dc-a857-4c45-8415-9684e140ee8f

Co-authored-by: ziflex <1607148+ziflex@users.noreply.github.com>
@ziflex

ziflex commented Apr 3, 2026

Copy link
Copy Markdown
Member

@copilot you forgot to mention there is a new "serve" command.

Agent-Logs-Url: https://github.com/MontFerret/lab/sessions/c2adfbed-80bb-436e-87b8-cfef8d31835c

Co-authored-by: ziflex <1607148+ziflex@users.noreply.github.com>

Copilot AI commented Apr 3, 2026

Copy link
Copy Markdown
Contributor Author

@copilot you forgot to mention there is a new "serve" command.

Added README coverage for the new lab serve command in commit e861482, including a short standalone usage example alongside the existing CDN docs.

Copilot AI changed the title Update README links for the main branch Update README for the main branch and document the serve command Apr 3, 2026
Copilot AI requested a review from ziflex April 3, 2026 21:57
@ziflex
ziflex marked this pull request as ready for review April 4, 2026 17:47
Copilot AI review requested due to automatic review settings April 4, 2026 17:47
@ziflex
ziflex merged commit f6b1022 into main Apr 4, 2026
7 checks passed
@ziflex
ziflex deleted the copilot/update-readme-documentation branch April 4, 2026 17:49

Copilot AI 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.

Pull request overview

This PR updates README links and examples to match the repository’s default main branch and documents the standalone lab serve command, improving copy/paste reliability and making the static server workflow more discoverable.

Changes:

  • Updated branch-specific GitHub-hosted URLs in the README from master to main (Codecov badge URL, landing image, install script).
  • Added a feature bullet and a new “Standalone Static Server” usage section demonstrating lab serve with single/multiple directories and aliases.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

3 participants