Skip to content

docs: link the live user guide from README - #80

Merged
DVOpenLabs merged 1 commit into
mainfrom
docs/guide-live-url
Oct 7, 2026
Merged

DVOpenLabs merged 1 commit into
mainfrom
docs/guide-live-url

Conversation

@DVOpenLabs

@DVOpenLabs DVOpenLabs commented Oct 7, 2026 •

Copy link
Copy Markdown
Owner

The guide is live at https://dvopenlabs.github.io/snapmaker-studio/ (PR #79 merged; Pages workflow succeeded). README now links the live URL; e2e gains --url to test a deployed copy; live-site screenshots added. In-app Help / Get Started already use this URL.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the main README to link directly to the published interactive guide, with local preview instructions and source details available in the guide directory.
    • Added a link to the live guide in the guide’s README.
    • Recorded the guide’s live deployment and end-to-end test result.

…deployed URL

Verified: tools/e2e.mjs --url https://dvopenlabs.github.io/snapmaker-studio/ -> 727/727.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Team
  • Run ID: 9f3ab3cb-8fd9-4430-b4d0-2e48ad37b67c
📥 Commits

Reviewing files that changed from the base of the PR and between 04bbe15 and 1a36f3f.

⛔ Files ignored due to path filters (10)
  • site/guide/evidence/live/figure-desktop-dark.png is excluded by !**/*.png
  • site/guide/evidence/live/figure-phone-light.png is excluded by !**/*.png
  • site/guide/evidence/live/lesson-more-tools-desktop-light.png is excluded by !**/*.png
  • site/guide/evidence/live/no-javascript.png is excluded by !**/*.png
  • site/guide/evidence/live/viewer-desktop-dark.png is excluded by !**/*.png
  • site/guide/evidence/live/walkthrough-desktop-dark.png is excluded by !**/*.png
  • site/guide/evidence/live/walkthrough-phone-dark.png is excluded by !**/*.png
  • site/guide/evidence/live/welcome-desktop-dark.png is excluded by !**/*.png
  • site/guide/evidence/live/welcome-desktop-light.png is excluded by !**/*.png
  • site/guide/evidence/live/welcome-phone-dark.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • README.md
  • site/guide/EVIDENCE.md
  • site/guide/README.md
  • site/guide/tools/e2e.mjs

Included review availability: This review used your included allowance. 7 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 8 reviews per hour.


📝 Walkthrough

Walkthrough

The README now links to the published interactive guide. The guide README and evidence record describe the live deployment. The E2E script can test a supplied deployed URL or start a local server.

Changes

Guide deployment and testing

Layer / File(s) Summary
Select the E2E test base URL
site/guide/tools/e2e.mjs
The script accepts a deployed URL and normalizes its trailing slash. Without a supplied URL, it starts the local server and uses its loopback URL.
Document the published guide
README.md, site/guide/README.md, site/guide/EVIDENCE.md
The READMEs link to the published guide and identify GitHub Pages as its publisher. The evidence record documents the deployment checks, live-site E2E result, and CSP header status.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 1a36f

The README links to the live guide, and deployed E2E checks preserve its project path. No concrete merge-blocking issue remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: linking the live user guide from the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@DVOpenLabs
DVOpenLabs merged commit 65bb6ad into main Oct 7, 2026
9 checks passed
@DVOpenLabs
DVOpenLabs deleted the docs/guide-live-url branch October 8, 2026 20:28
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