Skip to content

refactor: Rework the use case pages - #266

Open
danielvallance wants to merge 1 commit into
prod-stagingfrom
danielvallance/use_case_docs_rework
Open

refactor: Rework the use case pages#266
danielvallance wants to merge 1 commit into
prod-stagingfrom
danielvallance/use_case_docs_rework

Conversation

@danielvallance

Copy link
Copy Markdown
Contributor

The aim of this rework is to more visually
demonstrate the value adds to someone who
is not familiar with Unikraft Cloud by using
clear concise language, diagrams, and a clear
call to action.

@danielvallance
danielvallance temporarily deployed to pull-requests August 21, 2026 16:52 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests August 21, 2026 16:59 Inactive
@danielvallance
danielvallance force-pushed the danielvallance/use_case_docs_rework branch from 5b506cb to a049a7f Compare August 21, 2026 17:08
@danielvallance
danielvallance temporarily deployed to pull-requests August 21, 2026 17:08 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests August 21, 2026 17:09 Inactive
@danielvallance
danielvallance temporarily deployed to pull-requests August 21, 2026 17:10 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests August 21, 2026 17:13 Inactive
@danielvallance
danielvallance force-pushed the danielvallance/use_case_docs_rework branch from a049a7f to e8d3cc4 Compare August 24, 2026 08:45
@danielvallance
danielvallance temporarily deployed to pull-requests August 24, 2026 08:45 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests August 24, 2026 08:49 Inactive
@danielvallance
danielvallance force-pushed the danielvallance/use_case_docs_rework branch from e8d3cc4 to e405855 Compare August 24, 2026 13:18
@danielvallance
danielvallance temporarily deployed to pull-requests August 24, 2026 13:18 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests August 24, 2026 13:22 Inactive
@danielvallance
danielvallance force-pushed the danielvallance/use_case_docs_rework branch from e405855 to 38db5a7 Compare August 24, 2026 15:22
@danielvallance
danielvallance temporarily deployed to pull-requests August 24, 2026 15:22 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests August 24, 2026 15:25 Inactive
@danielvallance
danielvallance force-pushed the danielvallance/use_case_docs_rework branch from 38db5a7 to b091fc2 Compare August 25, 2026 10:27
@danielvallance
danielvallance temporarily deployed to pull-requests August 25, 2026 10:28 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests August 25, 2026 10:31 Inactive
@danielvallance
danielvallance force-pushed the danielvallance/use_case_docs_rework branch from b091fc2 to 13d4a75 Compare August 25, 2026 10:33
@danielvallance
danielvallance temporarily deployed to pull-requests August 25, 2026 10:33 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests August 25, 2026 10:37 Inactive
@danielvallance
danielvallance force-pushed the danielvallance/use_case_docs_rework branch from 13d4a75 to 61283d0 Compare August 25, 2026 10:42
@danielvallance
danielvallance temporarily deployed to pull-requests August 25, 2026 10:42 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests August 25, 2026 10:46 Inactive
@danielvallance
danielvallance force-pushed the danielvallance/use_case_docs_rework branch from 61283d0 to 585911d Compare August 25, 2026 11:56
@danielvallance
danielvallance temporarily deployed to pull-requests August 25, 2026 11:57 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests August 25, 2026 12:01 Inactive
The aim of this rework is to more visually
demonstrate the value adds to someone who
is not familiar with Unikraft Cloud by using
clear concise language, diagrams, and a clear
call to action.

Signed-off-by: Daniel Vallance <daniel@unikraft.com>
@danielvallance
danielvallance force-pushed the danielvallance/use_case_docs_rework branch from 585911d to 60c4c6e Compare August 25, 2026 16:51
@danielvallance
danielvallance temporarily deployed to pull-requests August 25, 2026 16:51 — with GitHub Actions Inactive
@github-actions
github-actions Bot temporarily deployed to pull-requests August 25, 2026 16:55 Inactive
@danielvallance
danielvallance requested a balanced review from Copilot August 26, 2026 10:36

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

Pull request overview

Reworks use-case documentation into concise, visual product pages with diagrams, media, feature summaries, and guide calls to action.

Changes:

  • Adds reusable diagram, card, CTA, and media components.
  • Rewrites twelve use-case pages and adds an overview.
  • Registers components and updates navigation and redirects.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
zudoku.config.tsx Registers components and overview routing.
src/UseCaseMedia.tsx Adds video and terminal-recording players.
src/DiagramComponents.tsx Adds shared visual and CTA components.
pages/use-cases/overview.mdx Adds the use-case catalog.
pages/use-cases/webhooks.mdx Reframes webhook benefits visually.
pages/use-cases/serverless-functions.mdx Highlights templates, ROMs, and isolation.
pages/use-cases/serverless-databases.mdx Presents cloning, restoration, and scale-to-zero.
pages/use-cases/sandboxes.mdx Highlights isolated sandbox capabilities.
pages/use-cases/remote-ides.mdx Summarizes persistent remote IDE environments.
pages/use-cases/remote-desktops.mdx Presents resumable cloud desktops.
pages/use-cases/mcp-servers.mdx Explains on-demand MCP hosting.
pages/use-cases/headless-browsers.mdx Expands browser automation coverage.
pages/use-cases/game-servers.mdx Highlights scalable game-server sessions.
pages/use-cases/build-test-environments.mdx Presents snapshot-based build environments.
pages/use-cases/api-gateways.mdx Summarizes gateway scaling and balancing.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/DiagramComponents.tsx
accent ? "text-primary" : "text-muted-foreground"
}`}
viewBox="0 0 64 12"
} ${reverse ? "lg:-scale-x-100" : ""}`}
Comment thread src/DiagramComponents.tsx
: undefined
}
>
<FlowArrow accent />
Comment on lines +11 to +15
<ValueCard title="Test migrations on a clone of production" metric="few ms downtime on the original">
[Branch](/features/branching) a running database — memory and [volume](/platform/volumes) state included — and run the risky migration against the copy.
</ValueCard>
<ValueCard title="Restore from a known good snapshot" metric="restore in < 10 ms">
[Checkpoints](/features/checkpoints) keep a history of full instance state, so rolling back is a restore rather than a rebuild.
Each gateway is a hardware-isolated microVM with its own kernel, not a process sharing a host runtime.
</ValueCard>
<ValueCard title="Low latency at the edge" metric="ultra-low latency">
Millisecond cold starts, minimal memory footprints and transparent [load balancing](/features/load-balancing) within a service group results in ultra-low latency

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

Very cool PR!! Seriously made me read the pages (I literally skipped reading them this morning).

One final nit, lots of em-dashes in the text -- gives a strong AI smell... Worth giving it a pass through an /unslop skill.

You want to swap test logic, keep startup latency low, and avoid rebuilding full images for every test change.
{/* vale off */}

Give every build or test job its own microVM: your full toolchain, started from a [snapshot](/features/snapshots) in milliseconds, with that job's code injected at boot.

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.

Not a very clear sentence.

@@ -0,0 +1,145 @@
---

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.

Image

Would be good to add a "Uses the following Unikraft features: " or just "Uses: " 🤔

Comment on lines +27 to +32
<FlowArrow accent label="wakes in < 10 ms" lines={3} />
<FlowStack>
<FlowStackItem label="mcp server" chip="mid-request" active dot />
<FlowStackItem label="mcp server" chip="standby" dot />
<FlowStackItem label="mcp server" chip="standby" dot />
</FlowStack>

@aabedraba aabedraba Aug 26, 2026

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.

Probably a two way arrow here.

@@ -3,129 +3,69 @@ title: Webhooks
navigation_icon: plug

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.

I wonder if there are mechanisms to keep a long running job in the instance running after the network request, and if we should document this here.

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

One more thing!

This text looks like a link, and I have tried to click on them multiple times even though I failed to do it at once.

Image

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