[binaryfire]

Adds a notice to the top of the home page and every docs page:

This site is for Hypervel 0.3. Hypervel 0.4 is a ground-up rewrite — launching soon, along with a new website and docs!

It uses the site's existing warning box style. Docs pages get it through the default theme's page-content-top layout slot. The home layout has no slots, so a small wrapper around VPHomeHero adds it there.

Also ports hypervel/hypervel.org#7 (model serialization in queues.md), which was merged after the docs moved into this repo and never made it across.

Note

Add Hypervel 0.3 version notice to docs site and fix queue serialization docs

• Adds a VersionNotice warning that the site documents Hypervel 0.3 and that 0.4 is a ground-up rewrite with new docs planned. It appears via a custom Layout.vue and an aliased HomeHero.vue registered in config.js and client.js.
• Reworks queues.md to describe full-model snapshot serialization as the default, with identifier-based serialization via QueueableEntity as an option. Adds an example model implementation, withoutRelations guidance, and updated missing-model notes.
• Behavioral Change: home page and all doc pages now render the version notice; queue docs now state the default serialization behavior differently.

^{Macroscope summarized 8dd3bad.}

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 11f9e02e-7af3-4dfc-8159-f9eed7f1a836

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• Trigger review

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

• X
• Mastodon
• Reddit
• LinkedIn

[qodo-free-for-open-source-projects]

PR Summary by Qodo

Add Hypervel 0.3 site notice and correct queue serialization docs

📝 Documentation ✨ Enhancement 🕐 10-20 Minutes

AI Description

• Identify the site as Hypervel 0.3 documentation on the home page and docs pages.
• Explain the upcoming Hypervel 0.4 rewrite and its separate website and docs.
• Correct queue guidance to distinguish default model snapshots from opt-in identifier-based
 serialization.

Diagram

graph TD
  Client["Client config"] --> Layout["Docs layout"] --> Notice["Version notice"] --> Docs["Docs pages"]
  Config["Site config"] --> Hero["Home hero"] --> Notice --> Home["Home page"]

Loading

High-Level Assessment

Keep the shared notice component with the theme slot for docs pages and the small hero wrapper for the slotless home page. Duplicating notices in Markdown or replacing the entire default theme would increase maintenance for no clear benefit.

Files changed (6) +80 / -6

Enhancement (3) +29 / -0

client.jsRegister the custom documentation layout +8/-0

Register the custom documentation layout

• Adds VuePress client configuration that registers the layout used to display the notice on documentation pages.

docs/.vuepress/client.js

HomeHero.vueShow the notice before the home hero +9/-0

Show the notice before the home hero

• Wraps the default home hero with the shared version notice so the landing page displays it without replacing the rest of the hero.

docs/.vuepress/components/HomeHero.vue

Layout.vuePlace the notice above documentation content +12/-0

Place the notice above documentation content

• Wraps the default theme layout and renders the shared notice in its page-content-top slot.

docs/.vuepress/layouts/Layout.vue

Documentation (2) +43 / -6

VersionNotice.vueDefine the shared Hypervel version notice +6/-0

Define the shared Hypervel version notice

• Adds a warning-style component identifying the site as Hypervel 0.3 documentation and announcing the forthcoming Hypervel 0.4 site and docs.

docs/.vuepress/components/VersionNotice.vue

queues.mdCorrect queued model serialization guidance +37/-6

Correct queued model serialization guidance

• Explains that models are serialized as snapshots by default and documents QueueableEntity as the opt-in path for identifier-based restoration. Clarifies relationship handling, queueable collections, and when missing-model failures can occur.

docs/docs/queues.md

Other (1) +8 / -0

config.jsAlias the default home hero to the notice wrapper +8/-0

Alias the default home hero to the notice wrapper

• Configures VuePress to use the local home-hero wrapper, allowing the notice to appear on the landing page.

docs/.vuepress/config.js

[qodo-free-for-open-source-projects]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Tip of the day

💡 Did you know, you can commit Qodo's fix in one click with committable suggestions (GitHub & GitLab)

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗