Skip to content

docs: added AspireC4 aspire hosting to the docs site, community area#2952

Merged
davydkov merged 12 commits into
mainfrom
kieron/added-aspirec4
May 18, 2026
Merged

docs: added AspireC4 aspire hosting to the docs site, community area#2952
davydkov merged 12 commits into
mainfrom
kieron/added-aspirec4

Conversation

@kieronlanning

Copy link
Copy Markdown
Collaborator

Checklist

  • I've thoroughly read the latest contribution guidelines.
  • I've rebased my branch onto main before creating this PR.
  • I've added tests to cover my changes (if applicable).
  • I've verified pnpm typecheck and pnpm test.
  • I've added changesets (you can use /changeset-generator SKILL).
  • My change requires documentation updates.
  • I've updated the documentation accordingly (or will do in follow-up PR).

Copilot AI review requested due to automatic review settings May 12, 2026 16:55
@coderabbitai

coderabbitai Bot commented May 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds an AspireC4 community MDX docs page (setup, quick-start, data flow, state mapping, links, modes, exclusions, limitations), a DSL styling tip for light/dark SVG icons, a changeset for @likec4/docs-astro, a pinned devcontainer features lock, and a pnpm.onlyBuiltDependencies allowlist update in package.json.

Changes

AspireC4 Community Documentation

Layer / File(s) Summary
Release metadata
.changeset/add-aspirec4-community-docs.md
Changeset entry for @likec4/docs-astro patch release announcing AspireC4 community docs.
DSL styling tip: light/dark SVG
apps/docs/src/content/docs/dsl/styling.mdx
Tip demonstrating embedding light and dark SVG variants in one file and toggling with prefers-color-scheme, with example snippet and image.
Introduction, links, prerequisites, and quick-start
apps/docs/src/content/docs/tooling/Community/aspirec4.mdx
MDX frontmatter, caution, GitHub/NuGet/project links, prerequisites (Docker or local CLI), and quick-start AddAspireC4() AppHost example with generated outputs.
Basic vs Enhanced setup
apps/docs/src/content/docs/tooling/Community/aspirec4.mdx
Basic and Enhanced setup tabs including AddAspireC4(opts => ...), WithLikeC4Details(...), and WithLikeC4Reference(...) examples with images.
How it works — model generation and serving
apps/docs/src/content/docs/tooling/Community/aspirec4.mdx
Data-flow from Aspire resources through model/DSL generation to ./likec4/model.gen.c4, and LikeC4 serving with hot-reload on file changes.
Runtime state → diagram color mapping
apps/docs/src/content/docs/tooling/Community/aspirec4.mdx
Documents runtime state-to-color mapping for LikeC4 elements (Unknown/Starting/Running/Stopping/Exited/Failed/Error).
Dashboard deep-links and security toggle
apps/docs/src/content/docs/tooling/Community/aspirec4.mdx
Dashboard deep-link injection behavior, per-element Console/Structured Logs links built after dashboard Running, browser token embedding, and disabling via IncludeAspireDashboardLinks = false.
Alternative modes and hiding sidecar
apps/docs/src/content/docs/tooling/Community/aspirec4.mdx
WithLocalCLI() operation and WithHideFromDashboard() usage, with diagram URL/command exposure.
Resource exclusion rules
apps/docs/src/content/docs/tooling/Community/aspirec4.mdx
ExcludeFromLikeC4Annotation, Aspire snapshot hiding rules, and note that the LikeC4 sidecar is always excluded.
Limitations
apps/docs/src/content/docs/tooling/Community/aspirec4.mdx
Notes on HMR-required refresh, dashboard URL discovery timing, browser token present in generated .c4, and Windows HMR relay behavior.
Devcontainer feature lock
.devcontainer/devcontainer-lock.json
Pins devcontainer feature artifacts to exact version, resolved, and integrity SHA256 values.
pnpm onlyBuiltDependencies allowlist
package.json
Replaces @google/genai with @openrouter/sdk and removes protobufjs from pnpm.onlyBuiltDependencies allowlist.

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers:

  • davydkov
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding AspireC4 documentation to the docs site's community section.
Description check ✅ Passed The PR description follows the required template with most items checked off appropriately, indicating the author completed contribution requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch kieron/added-aspirec4

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

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

@kieronlanning kieronlanning requested a review from davydkov May 12, 2026 16:56

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

Adds a new Community documentation page to the docs site for AspireC4, a .NET Aspire hosting/extension that generates live LikeC4 diagrams from the Aspire resource graph.

Changes:

  • Added a new Community docs page describing AspireC4 setup, behavior, and configuration options.
  • Added a changeset to publish the docs update as a patch to @likec4/docs-astro.

Reviewed changes

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

File Description
apps/docs/src/content/docs/tooling/Community/aspirec4.mdx New Community documentation page for AspireC4 (overview, quick start, configuration, limitations).
.changeset/add-aspirec4-community-docs.md Changeset to release the docs update as a patch.

label: 'AspireC4 - Aspire Integration'
---

import { LinkCard, CardGrid, LinkButton } from '@astrojs/starlight/components';
Comment thread apps/docs/src/content/docs/tooling/Community/aspirec4.mdx Outdated
@changeset-bot

changeset-bot Bot commented May 13, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 91020dd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 22 packages
Name Type
@likec4/docs-astro Patch
likec4 Patch
likec4-vscode Patch
@likec4/playground Patch
@likec4/style-preset Patch
@likec4/styles Patch
@likec4/config Patch
@likec4/core Patch
@likec4/diagram Patch
@likec4/generators Patch
@likec4/language-server Patch
@likec4/language-services Patch
@likec4/layouts Patch
@likec4/leanix-bridge Patch
@likec4/spa Patch
@likec4/log Patch
@likec4/lsp Patch
@likec4/mcp Patch
@likec4/react Patch
@likec4/tsconfig Patch
@likec4/vite-plugin Patch
@likec4/vscode-preview Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

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

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 `@apps/docs/src/content/docs/dsl/styling.mdx`:
- Around line 235-239: Fix the wording and the code-fence language in the tip:
change the phrase "dark mode's" to "dark modes" in the sentence that begins
"When using SVGs, you can bake the light and dark mode's into a single file",
and change the code fence language token from "```xmlm" to "```xml" (the fenced
code block immediately following that sentence).
🪄 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: c8b00cf5-481a-4ee9-a479-aed8ed591803

📥 Commits

Reviewing files that changed from the base of the PR and between ac31f5e and 1e860f2.

⛔ Files ignored due to path filters (3)
  • apps/docs/src/assets/logo.svg is excluded by !**/*.svg
  • apps/docs/src/assets/tooling/community/aspirec4/makerstack-basic.png is excluded by !**/*.png
  • apps/docs/src/assets/tooling/community/aspirec4/makerstack-enhanced.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • apps/docs/src/content/docs/dsl/styling.mdx
  • apps/docs/src/content/docs/tooling/Community/aspirec4.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/docs/src/content/docs/tooling/Community/aspirec4.mdx

Comment thread apps/docs/src/content/docs/dsl/styling.mdx Outdated
kieronlanning and others added 3 commits May 13, 2026 14:45
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Kieron Lanning <kieronlanning@users.noreply.github.com>

@davydkov davydkov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kieronlanning Thank you!
Please fix failing build and merge it

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
package.json (1)

130-139: ⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

Add @openrouter/sdk to devDependencies — it's listed in onlyBuiltDependencies but not declared as a dependency.

The onlyBuiltDependencies configuration controls which packages pnpm treats as build-only, but every package in that list must be declared in dependencies or devDependencies. Currently, @openrouter/sdk appears only in onlyBuiltDependencies (line 131) and is missing from the devDependencies section. This will cause pnpm resolution failures.

Add @openrouter/sdk to devDependencies with an appropriate version, or remove it from onlyBuiltDependencies if it's not needed.

(Note: @google/genai and protobufjs removals are complete and verified.)

🤖 Prompt for 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.

In `@package.json` around lines 130 - 139, The package "`@openrouter/sdk`" is listed
in onlyBuiltDependencies but not declared, causing pnpm resolution failures;
update package.json by adding "`@openrouter/sdk`" to devDependencies with a
suitable semver (or alternatively remove "`@openrouter/sdk`" from the
onlyBuiltDependencies array if it shouldn't be build-only), ensuring you edit
the devDependencies section and the onlyBuiltDependencies array entries so the
package appears in both places (or is removed) and re-run install to verify
resolution.
🤖 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.

Outside diff comments:
In `@package.json`:
- Around line 130-139: The package "`@openrouter/sdk`" is listed in
onlyBuiltDependencies but not declared, causing pnpm resolution failures; update
package.json by adding "`@openrouter/sdk`" to devDependencies with a suitable
semver (or alternatively remove "`@openrouter/sdk`" from the onlyBuiltDependencies
array if it shouldn't be build-only), ensuring you edit the devDependencies
section and the onlyBuiltDependencies array entries so the package appears in
both places (or is removed) and re-run install to verify resolution.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7a028179-231e-4abf-87b5-da35e90a5265

📥 Commits

Reviewing files that changed from the base of the PR and between 36fe64e and 06c5c96.

📒 Files selected for processing (3)
  • .devcontainer/devcontainer-lock.json
  • apps/docs/src/content/docs/dsl/styling.mdx
  • package.json
✅ Files skipped from review due to trivial changes (2)
  • apps/docs/src/content/docs/dsl/styling.mdx
  • .devcontainer/devcontainer-lock.json

@kieronlanning

Copy link
Copy Markdown
Collaborator Author

@kieronlanning Thank you! Please fix failing build and merge it

Interestinly, locally that showed as a warning - but it was so early in the build phase I'd missed it in the terminal... so it all looked good.

Anyway, should be sorted now.

@davydkov davydkov merged commit 0a1b751 into main May 18, 2026
19 checks passed
@davydkov davydkov deleted the kieron/added-aspirec4 branch May 18, 2026 07:05
@likec4-ci likec4-ci Bot mentioned this pull request May 18, 2026
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