mirror of
https://github.com/webstudio-is/webstudio.git
synced 2026-11-09 22:14:29 +09:00
Oleg Isonen
1b48716ff4
## Summary - Document how people create, connect, edit, validate, and publish MDX-backed Content Blocks. - Document the complete MCP workflow, including scoped expression sources, frontmatter updates, diagnostics, conflicts, and disconnect behavior. - Add two focused screenshots for the human workflow. - Fix issues found by a low-reasoning MCP agent while executing every documented workflow. Ref #6182 ## Implementation notes - Connection confirmation uses the public `confirmReplacement` field because `confirm` is reserved as a hidden transport field. - MCP edits frontmatter with `update-content-block-frontmatter`; materialized MDX elements are not persistent targets for generic instance mutation tools. - Reload now intentionally discards a conflicted local source and accepts the Asset's latest storage revision before an edit is reapplied. - Generated MCP documentation and runtime contracts are updated from their source files. ## Checklist - [x] Document the human MDX Content Block workflow. - [x] Document MCP discovery, connection, editing, diagnostics, frontmatter, dynamic sources, conflicts, and disconnection. - [x] Add only screenshots that clarify otherwise hard-to-describe UI steps. - [x] Test every documented MDX capability through the local MCP CLI with a low-reasoning agent. - [x] Reproduce and fix the replacement-confirmation schema mismatch. - [x] Reproduce and fix persistent-session conflict reload and reapply. - [x] Add regression tests that failed before each product fix and pass afterward. - [x] Regenerate runtime contracts and generated MCP documentation. - [x] Review authoritative `docs/` content and update affected pages. - [x] Run affected tests, typechecks, formatting, and diff checks. ## Verification - Project Build: 208 affected tests passed. - Content Engine Asset session: 8 tests passed. - CLI documentation tests: 14 tests passed. - MCP docs generator: 3 tests passed. - Content Engine, Project Build, CLI, and MCP docs typechecks passed. - `pnpm oxfmt --check` passed. - `git diff --check` passed. - Low-reasoning MCP evaluation passed all documented workflows, including a real two-client revision conflict, reload, reapply, and final saved inspection.
70 lines
2.0 KiB
Markdown
70 lines
2.0 KiB
Markdown
---
|
|
description: New to Webstudio?
|
|
---
|
|
|
|
# 👋 Welcome
|
|
|
|
Our getting started guide will help you navigate through building your first Webstudio website. It covers the essentials of creating web designs and integrating third-party tools. You'll learn how to utilize Webstudio's unique features like Design tokens and Components, and how to contribute to the project.
|
|
|
|
[**Get started**](basics/building-your-first-site.md)
|
|
|
|
***
|
|
|
|
{% content-ref url="basics/building-your-first-site.md" %}
|
|
[building-your-first-site.md](basics/building-your-first-site.md)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="university/foundations/" %}
|
|
[foundations](university/foundations/)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="university/core-components/" %}
|
|
[core-components](university/core-components/)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="university/cli.md" %}
|
|
[cli.md](university/cli.md)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="university/inception.md" %}
|
|
[inception.md](university/inception.md)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="university/radix/" %}
|
|
[radix](university/radix/)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="university/marketplace.md" %}
|
|
[marketplace.md](university/marketplace.md)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="university/self-hosting/" %}
|
|
[self-hosting](university/self-hosting/)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="university/how-tos/" %}
|
|
[how-tos](university/how-tos/)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="university/integrations/" %}
|
|
[integrations](university/integrations/)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="university/craft.md" %}
|
|
[craft.md](university/craft.md)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="basics/FAQ.md" %}
|
|
[FAQ.md](basics/FAQ.md)
|
|
{% endcontent-ref %}
|
|
|
|
## Looking to contribute to Webstudio?
|
|
|
|
{% content-ref url="contributing/contributions.md" %}
|
|
[contributions.md](contributing/contributions.md)
|
|
{% endcontent-ref %}
|
|
|
|
{% content-ref url="contributing/marketplace.md" %}
|
|
[marketplace.md](contributing/marketplace.md)
|
|
{% endcontent-ref %}
|