Skip to content

docs(build-system/docs-template): add MCP and CLI consumer guides - #930

Merged
raininforest merged 4 commits into
developfrom
feature/improve-user-flow
Sep 23, 2026
Merged

raininforest merged 4 commits into
developfrom
feature/improve-user-flow

Conversation

@raininforest

Copy link
Copy Markdown
Collaborator
  • Добавлена документация MCP и CLI в шаблоны документации
  • Небольшие улучшения в theme-builder

Add mcp.md and cli.md to common-template so every generated site
(Compose and XML) documents how an external design-system consumer
connects an AI agent via MCP and installs/uses the dsbuilder CLI.
Both compose-template and xml-template ship their own sidebars.ts
that override common-template's copy on generation, so the new
'cli'/'mcp' sidebar entries (CLI before MCP, since the MCP quick
start depends on the CLI being installed) had to be added to all
three sidebars.ts. Both quick_start.md files link to the new pages
as two separate items.
…cope

Bring proposal/design/spec/tasks in line with the actual mcp.md/cli.md
content after several rounds of scope correction: theme fetch and
components fetch are a consumer pull scenario (not a maintainer
write scenario like components push/docs publish), MCP is documented
only in the context of the CLI (no npx/no-CLI fallback), and the
quick start now has an explicit numbered "run the server" step.
…on classpath

GenerateComponentsTask previously completed successfully without
generating any component styles if a module declared non-empty
components but the corresponding uikit-*-api-meta.json wasn't on the
compile classpath (missing sdds-uikit/sdds-uikit-compose dependency).
Add requireUikitMetaPresent, which throws ThemeBuilderException with
an actionable message per target (Compose/View) instead of silently
producing no output. ViewMetaIndex gains isEmpty to support the check
on the View side.
@raininforest raininforest self-assigned this Sep 22, 2026
@raininforest raininforest added documentation Improvements or additions to documentation changelog-skip labels Sep 22, 2026
@coderabbitai

coderabbitai Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

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

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 9731a623-4813-4a3b-89cc-c8fc0a150bd8

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

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.

Comment thread build-system/docs-template/common-template/docs/cli.md Outdated
Comment thread build-system/docs-template/common-template/docs/cli.md Outdated
Comment thread build-system/docs-template/common-template/docs/mcp.md Outdated
Comment thread build-system/docs-template/common-template/docs/mcp.md Outdated
@raininforest
raininforest force-pushed the feature/improve-user-flow branch from e201283 to 06f718b Compare September 23, 2026 07:59
@raininforest
raininforest merged commit 29248eb into develop Sep 23, 2026
19 checks passed
@raininforest
raininforest deleted the feature/improve-user-flow branch September 23, 2026 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog-skip documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants