Skip to content

docs: updates for release 0.6.0#1178

Open
zeroedin wants to merge 34 commits into
mainfrom
docs/release-0-6-0
Open

docs: updates for release 0.6.0#1178
zeroedin wants to merge 34 commits into
mainfrom
docs/release-0-6-0

Conversation

@zeroedin

@zeroedin zeroedin commented Jul 24, 2026

Copy link
Copy Markdown
Owner

Summary

Umbrella PR for all v0.6.0 documentation updates. Individual changes are reviewed in separate PRs targeting this branch:

Merge order for hooks/index.md: #1166#1167#1169#1171 (each edits different sections but will need conflict resolution in sequence).

Merge this to main after PR #1108 (v0.6.0 release) ships.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated onPageRendered hook guidance and examples to use a page object (mutate page.html, keep metadata read-only).
    • Expanded routing/dispatch notes around when onPageRendered vs onFormatRendered is applied, and updated related examples (SSR, formatting, syntax highlighting, plugin usage).
    • Documented the experimental components/ directory and the structure.components override for SSR component sources.
  • Bug Fixes
    • Standardized onPageRendered implementations to transform and return the full page context consistently, including on failure.

zeroedin and others added 14 commits July 24, 2026 09:26
Closes #1164

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Closes #1161

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Update the Lit SSR example to use the new object API where
onPageRendered receives { html, frontMatter, url, path } instead of a
raw HTML string. Add onFormatRendered to the worker pool hook list.

Closes #1160

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Closes #1156

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Closes #1162

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Closes #1154

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Closes #1157
Closes #1165

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Closes #1119

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Closes #1147
Closes #1159

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Closes #1163

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Closes #1155

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Closes #1158

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Umbrella branch for all v0.6.0 documentation updates.
Individual changes merge here before shipping to main.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@netlify

netlify Bot commented Jul 24, 2026

Copy link
Copy Markdown

Deploy Preview for alloyssg ready!

Name Link
🔨 Latest commit 4ff56a3
🔍 Latest deploy log https://app.netlify.com/projects/alloyssg/deploys/6a63724230840f00083a02b6
😎 Deploy Preview https://deploy-preview-1178--alloyssg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

…ect-api

docs: update onPageRendered examples to object API
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 31 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0c26c253-dd73-4cef-ada4-54c3d36a14b3

📥 Commits

Reviewing files that changed from the base of the PR and between d7b3741 and 4ff56a3.

📒 Files selected for processing (8)
  • docs/content/advanced/ssr.md
  • docs/content/cli/index.md
  • docs/content/getting-started/project-structure.md
  • docs/content/hooks/index.md
  • docs/content/plugins/node.md
  • docs/content/releases/v0.6.0.md
  • docs/content/templates/output-formats.md
  • docs/content/upgrade/index.md
📝 Walkthrough

Walkthrough

The onPageRendered hook now receives and returns a page object with transformations stored in page.html. Documentation also covers non-HTML rendering hooks and the experimental SSR component directory.

Changes

Page-rendered hook migration

Layer / File(s) Summary
Document the page-object hook contract
docs/content/hooks/index.md, docs/content/plugins/*, docs/content/advanced/ssr.md
Hook documentation and examples describe page.html mutation, returned page objects, read-only page fields, and dispatch behavior for non-HTML outputs.
Update plugin hook integrations
docs/plugins/lit-ssr.js, docs/plugins/prettify.js, docs/plugins/shiki.js
Plugin handlers read and transform page.html, preserve error handling, and return the page object.

SSR component directory documentation

Layer / File(s) Summary
Document the SSR component directory
docs/content/configuration/index.md, docs/content/experimental/ssr.md, docs/content/getting-started/project-structure.md
Documentation adds the structure.components option and describes the default components/ directory and serve-time watching behavior.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related issues

Possibly related PRs

  • zeroedin/alloy#1118 — Both PRs update onPageRendered to mutate page.html and return a page object.
  • zeroedin/alloy#1134 — Both changes align hook behavior with page-level rendering and HTML-output dispatch.

Suggested reviewers: claude

Poem

A rabbit hops through rendered light,
page.html now turns out right.
Components bloom in folders near,
While hooks guide formats clear.
Ears up high, the docs now sing—
A polished page in every ring!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects that this is an umbrella documentation update for the v0.6.0 release.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/release-0-6-0

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

zeroedin and others added 3 commits July 24, 2026 09:43
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…e-iteration

docs: document onFormatRendered hook reference
docs: add structure.components to configuration reference

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/content/advanced/ssr.md`:
- Line 53: Update the onPageRendered hook registration in the SSR example to
pass an empty options object as the second argument before the async callback,
matching the alloy.hook API signature.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6906ae99-24df-48d0-871c-adfd14ef2fd0

📥 Commits

Reviewing files that changed from the base of the PR and between 1f10816 and 2871b51.

📒 Files selected for processing (7)
  • docs/content/advanced/ssr.md
  • docs/content/hooks/index.md
  • docs/content/plugins/index.md
  • docs/content/plugins/quickjs.md
  • docs/plugins/lit-ssr.js
  • docs/plugins/prettify.js
  • docs/plugins/shiki.js

Comment thread docs/content/advanced/ssr.md Outdated
zeroedin and others added 9 commits July 24, 2026 09:48
… sections

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
docs: document server lockfile behavior for dev/serve
docs: update onBuildComplete payload for v0.6.0
docs: update onPageRendered examples in Node plugins page
Replace two dense paragraphs with a routing table and shorter prose.
Payload field details stay on the hooks page where they belong.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Heading to noun phrase matching page conventions
- "route through" → "fire"
- Drop redundant "for that format" and "Hooks that fire" column header
- Inline link text instead of "See X for Y" pattern

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ormats

docs: add onFormatRendered cross-reference to output formats page
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
zeroedin and others added 7 commits July 24, 2026 09:58
docs: document .alloy/ directory in project structure page
- Cut 35-word opening sentence to two shorter ones
- Remove "This is useful for:" throat-clearing
- Fold use cases into prose instead of bolded bullet list
- Remove em dash
- Cut "on disk" repetition and redundant "re-evaluates all plugin files"

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
docs: document onFileChanged restart behavior on Node plugins page
docs: add release notes link to upgrade page
- Remove em dash, "silently" adverb
- Fix passive constructions: "is freed" → "Alloy frees", "are auto-cleaned" → "Alloy removes",
  "Paths are normalized" → "Alloy normalizes", "a warning prints" → "Alloy prints a warning"
- Cut redundant "Previously received a raw HTML string" (breaking note already says "instead of")
- Fix pagesSkipped → PagesSkipped (old field name was PascalCase)
- Add missing subjects on "Previously" sentences
- Tighten mixed-outputs sentence, collapse "This feature is experimental" inline

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
docs: create v0.6.0 release notes page
The alloy.hook() API requires an options object as the second argument.
The SSR example was missing it after the v0.6.0 object API migration.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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