diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c4017a8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,108 @@ +# Contributing to Stack documentation + +Canonical user documentation and generated agent guidance for Stack architecture diagrams. + +## Ownership + +See [machine resource distribution](./MACHINE_RESOURCES.md) for the versioned +schema, grammar, diagnostics, examples, capability manifest, and consumer example. + +Edit the shared agent workflow in `content/agent-workflow.md`. Both the installable +skill and the human-readable workflow are generated from this one source. Skill +discovery metadata lives in `content/skill-metadata.json`, and published CLI +identity lives in `content/cli-release.json`. + +The canonical four-locale site sources live in `content/site/`. Preserve route +parity across English, Japanese, Chinese, and Korean pages when changing the site +inventory. Four generated `guide/agent-workflow.md` pages expose the canonical +English instructions used by the skill; the localized coding-agent guides explain +this and share one copyable prompt from `content/agent-prompt.txt`. This avoids +hand-maintaining the validation workflow both in a guide and a skill. +`{{cliVersion}}` comes from the release lock. + +The English product story lives in `content/product-story.json`; Japanese, +Chinese, and Korean UI copy lives in `content/product-story-locales.json`, keyed +by the canonical benefit IDs. `{{productHome}}` generates homepage metadata and +`{{productBenefits}}` generates the introduction's benefit list. Update those +sources rather than copying marketing text into page templates. The homepage +has only `hero.name` as its H1, a separate tagline, and a `description` field +for page metadata and the website's supporting hero paragraph. The website +owns rendering that paragraph; no example SVG is generated here. + +`generated/site/` contains complete Markdown inputs for the website. Website +presentation, images, VitePress configuration, and deployment are not owned here. + +Language syntax, schemas, and canonical examples remain owned by +[stack-sh/specification](https://github.com/stack-sh/specification). +[stack-sh/cli](https://github.com/stack-sh/cli) owns native command behavior and the +`npx skills add stack-sh/cli` installation entry point. +[stack-sh/web](https://github.com/stack-sh/web) owns the playground and deployment +at [stack-diagram.com/docs](https://stack-diagram.com/docs). + +## Generate and verify + +Node.js 22 or newer is required. Generation uses only Node.js built-ins and has no +install scripts. Tests and machine conformance checks require the pinned development +dependencies; install them with `npm ci --ignore-scripts` first. + +```sh +npm run generate +npm test +npm run check +``` + +Commit source and generated changes together. Do not edit `generated/` directly. +Check mode rejects modified, missing, or unexpected generated files. Generation +does not silently delete old files. The manifest records SHA-256 values and the +published CLI revision; hashes prove byte integrity, not publisher identity. + +Consumers must pin a reviewed, merged commit and verify its manifest and files. +The CLI's source revision is distinct from the documentation revision: updating +instructions does not publish a new CLI binary. Recheck capability statements +against the released binary's help when updating the release lock; changing a +version string alone does not prove a feature is available. + +## Keep the published CLI reference current + +Run `npm run release:sync` after a stable CLI release. It resolves the published +tag to its exact commit, updates `content/cli-release.json`, and regenerates all +version declarations. Review changed capabilities and run tests and the verified +release binary smoke before opening a PR. After merging, update both consumer +Docs pins and verify the website deployment and CLI skill installation. + +`npm run release:check` and the read-only daily freshness workflow reject a newer +unrecorded stable release or a retargeted tag. They do not publish, install a CLI, +or merge changes. Scheduled runs can be delayed and GitHub notification settings +control failure notifications. Web additionally audits the release it deploys. + +Site shell examples receive a generated `$ ` prompt; the installable skill keeps +executable command lines without prompts. The canonical source remains shared. + +## Consumer freshness + +`npm run consumers:check` compares the current generated content with the CLI and +Web main-branch pins and the website's public `/docs-source.json` deployment +provenance. It verifies every pinned manifest hash and the actual CLI skill bytes. +Equivalent content at an older commit is accepted; a website-only edit does not +require a pointless CLI skill update. Website production provenance identifies the +deployed source; it is not a substitute for checking rendered pages after release. + +The read-only Consumer freshness workflow runs after Docs main changes, daily, +and on manual dispatch. A source change may intentionally fail this audit until +the required consumer PRs and Web deployment finish. Update the affected pins, +run consumer tests, merge and deploy, then rerun the audit. It never grants write +permissions or silently auto-merges consumer updates. + +## Consumer ownership + +CLI consumes a reviewed Docs revision through `skills/docs-source.json`; Web uses +`scripts/docs-source.json`. Both verify the manifest hash and generated file bytes. +Do not edit the generated CLI skill or website Markdown inputs in those repositories. +Edit the original content here, then update only the affected consumer pins through +reviewed PRs. Equivalent generated content does not require a pin-only update. + +The website preserves the original four-locale routes and provides the machine +discovery endpoint. Its language, example, link, and build gates must continue to +pass. Source generation and deployment provenance alone do not prove rendered-site +compatibility: check public HTML/Markdown, agent discovery, and the consumer example +after deployment, then rerun the consumer freshness audit. diff --git a/README.md b/README.md index 546f27a..bd800ad 100644 --- a/README.md +++ b/README.md @@ -1,108 +1,81 @@ -# Stack documentation sources +# Stack documentation -Canonical user documentation and generated agent guidance for Stack architecture diagrams. +The shared source for Stack's user guides, language reference, and coding-agent guidance. +Stack turns text into architecture diagrams with consistent themes and fast, local rendering. +This repository keeps the instructions used by people, the website, and coding agents in sync. -## Ownership +## Read the docs -See [machine resource distribution](./MACHINE_RESOURCES.md) for the versioned -schema, grammar, diagnostics, examples, capability manifest, and consumer example. +- [English](https://stack-diagram.com/docs/) +- [日本語](https://stack-diagram.com/docs/ja/) +- [简体中文](https://stack-diagram.com/docs/zh/) +- [한국어](https://stack-diagram.com/docs/ko/) -Edit the shared agent workflow in `content/agent-workflow.md`. Both the installable -skill and the human-readable workflow are generated from this one source. Skill -discovery metadata lives in `content/skill-metadata.json`, and published CLI -identity lives in `content/cli-release.json`. +Start with [your first diagram](https://stack-diagram.com/docs/guide/getting-started), +browse the [example gallery](https://stack-diagram.com/docs/examples/), or try the +[Playground](https://stack-diagram.com/). Examples render from canonical `.stack` +source in your browser; they are not separately maintained SVG exports. -The four-locale site sources live in `content/site/`. They were imported from -`stack-sh/web` commit `c0c773fd2721a177c56406732c010808269e30bc` under Apache-2.0. -The original 56 page paths are preserved. Four generated `guide/agent-workflow.md` -pages expose the canonical English instructions used by the skill; the localized -coding-agent guides explain this and share one copyable prompt from -`content/agent-prompt.txt`. This avoids hand-maintaining the validation workflow -both in a guide and a skill. `{{cliVersion}}` comes from the release lock. +## Use Stack with a coding agent -The English product story lives in `content/product-story.json`; Japanese, -Chinese, and Korean UI copy lives in `content/product-story-locales.json`, keyed -by the canonical benefit IDs. `{{productHome}}` generates homepage metadata and -`{{productBenefits}}` generates the introduction's benefit list. Update those -sources rather than copying marketing text into page templates. The homepage -has only `hero.name` as its H1, a separate tagline, and a `description` field -for page metadata and the website's supporting hero paragraph. The website -owns rendering that paragraph; no example SVG is generated here. +Install the Stack skill through the official CLI repository: -`generated/site/` contains complete Markdown inputs for the website. Website -presentation, images, VitePress configuration, and deployment are not owned here. +```sh +npx skills add stack-sh/cli +``` + +The skill teaches an agent to write, check, format, and render Stack diagrams with +the CLI. Its instructions are generated here from the same +[agent workflow](https://stack-diagram.com/docs/guide/agent-workflow) published in +the docs. Installing a skill does not install the Stack CLI; follow the +[CLI installation guide](https://stack-diagram.com/docs/guide/getting-started) too. + +## Build an integration + +The public [machine resource index](https://stack-diagram.com/machine/index.json) +provides versioned discovery for schemas, syntax highlighting, diagnostics, +canonical examples, and implementation capabilities. Use it to find immutable, +hash-verified resources rather than scraping documentation pages. + +See [Machine resource distribution](./MACHINE_RESOURCES.md) for the contract and +the [working consumer example](./examples/read-machine-resources.mjs). +A versioned capability snapshot is immutable; it is not an alias for the latest CLI. -Language syntax, schemas, and canonical examples remain owned by +## How the sources reach users + +| Source here | Consumer | Published result | +| --- | --- | --- | +| Guides and reference in `content/site/` | [stack-sh/web](https://github.com/stack-sh/web) | The four-language documentation site | +| `content/agent-workflow.md` | Web and [stack-sh/cli](https://github.com/stack-sh/cli) | The readable agent workflow and installable skill | +| Machine resource definitions | Web | The public machine resource index and versioned manifests | + +The deterministic generator produces `generated/` and a SHA-256 manifest. +Consumers pin a reviewed commit and verify the generated bytes. Updating this +repository does not by itself deploy the website or publish a CLI binary. + +Language semantics, schemas, and canonical example sources are owned by [stack-sh/specification](https://github.com/stack-sh/specification). -[stack-sh/cli](https://github.com/stack-sh/cli) owns native command behavior and the -`npx skills add stack-sh/cli` installation entry point. -[stack-sh/web](https://github.com/stack-sh/web) owns the playground and deployment -at [stack-diagram.com/docs](https://stack-diagram.com/docs). +The [engine](https://github.com/stack-sh/engine) owns layout and rendering; +Web owns presentation and deployment; CLI owns native command behavior. -## Generate and verify +## Contribute -Node.js 22 or newer is required. Generation uses only Node.js built-ins and has no -install scripts. Tests and machine conformance checks require the pinned development -dependencies; install them with `npm ci --ignore-scripts` first. +Use Node.js 22 or newer: ```sh +npm ci --ignore-scripts npm run generate npm test npm run check +npm run machine:check ``` -Commit source and generated changes together. Do not edit `generated/` directly. -Check mode rejects modified, missing, or unexpected generated files. Generation -does not silently delete old files. The manifest records SHA-256 values and the -published CLI revision; hashes prove byte integrity, not publisher identity. - -Consumers must pin a reviewed, merged commit and verify its manifest and files. -The CLI's source revision is distinct from the documentation revision: updating -instructions does not publish a new CLI binary. Recheck capability statements -against the released binary's help when updating the release lock; changing a -version string alone does not prove a feature is available. - -## Keep the published CLI reference current - -Run `npm run release:sync` after a stable CLI release. It resolves the published -tag to its exact commit, updates `content/cli-release.json`, and regenerates all -version declarations. Review changed capabilities and run tests and the verified -release binary smoke before opening a PR. After merging, update both consumer -Docs pins and verify the website deployment and CLI skill installation. - -`npm run release:check` and the read-only daily freshness workflow reject a newer -unrecorded stable release or a retargeted tag. They do not publish, install a CLI, -or merge changes. Scheduled runs can be delayed and GitHub notification settings -control failure notifications. Web additionally audits the release it deploys. - -Site shell examples receive a generated `$ ` prompt; the installable skill keeps -executable command lines without prompts. The canonical source remains shared. - -## Consumer freshness - -`npm run consumers:check` compares the current generated content with the CLI and -Web main-branch pins and the website's public `/docs-source.json` deployment -provenance. It verifies every pinned manifest hash and the actual CLI skill bytes. -Equivalent content at an older commit is accepted; a website-only edit does not -require a pointless CLI skill update. Website production provenance identifies the -deployed source; it is not a substitute for checking rendered pages after release. - -The read-only Consumer freshness workflow runs after Docs main changes, daily, -and on manual dispatch. A source change may intentionally fail this audit until -the required consumer PRs and Web deployment finish. Update the affected pins, -run consumer tests, merge and deploy, then rerun the audit. It never grants write -permissions or silently auto-merges consumer updates. - -## Consumer ownership - -CLI consumes a reviewed Docs revision through `skills/docs-source.json`; Web uses -`scripts/docs-source.json`. Both verify the manifest hash and generated file bytes. -Do not edit the generated CLI skill or website Markdown inputs in those repositories. -Edit the original content here, then update only the affected consumer pins through -reviewed PRs. Equivalent generated content does not require a pin-only update. - -The website preserves the original four-locale routes and provides the machine -discovery endpoint. Its language, example, link, and build gates must continue to -pass. Source generation and deployment provenance alone do not prove rendered-site -compatibility: check public HTML/Markdown, agent discovery, and the consumer example -after deployment, then rerun the consumer freshness audit. +Edit `content/`, not `generated/`, and commit source and generated changes +together. See [Contributing](./CONTRIBUTING.md) for source ownership, release +synchronization, consumer updates, and verification. +Bug reports and documentation improvements are welcome through +[issues](https://github.com/stack-sh/docs/issues) and pull requests. + +## License + +[Apache-2.0](./LICENSE). diff --git a/content/cli-release.json b/content/cli-release.json index c8f29a1..4e62b5f 100644 --- a/content/cli-release.json +++ b/content/cli-release.json @@ -1,5 +1,5 @@ { "repository": "stack-sh/cli", - "revision": "1d5f64cc699e42f9ce52ac537903e40c0eb91432", - "version": "0.5.1" + "revision": "f6220c5c24bc515574ea6f6dd6d55af00d35f89d", + "version": "0.5.2" } diff --git a/content/site/examples/index.md b/content/site/examples/index.md index 80967d3..eb1d62a 100644 --- a/content/site/examples/index.md +++ b/content/site/examples/index.md @@ -1,7 +1,7 @@ # Example gallery -Start small, then explore groups, layout, and provider icons. Each preview loads a canonical `.stack` source and renders on your device with the same WASM engine as the Playground. Engine updates improve these previews too; no separate SVG images need regeneration. +Start small, then explore groups, layout, and complete systems. Every example here uses built-in icons, so no additional packs are needed. Previews render canonical `.stack` source on your device with the same WASM engine as the Playground. -This gallery uses built-in fallback shapes for provider icons. To use branded artwork in your own diagram, explicitly import the listed icon packs in the [Playground](../guide/provider-icons.md) or [CLI](../guide/getting-started.md). Source links remain available when JavaScript or preview loading is unavailable. +Select an image to enlarge it. Use actual size to inspect details, or fit the diagram to your screen. The separate source link lets you read and reuse the `.stack` code, even when JavaScript or preview loading is unavailable. diff --git a/content/site/ja/examples/index.md b/content/site/ja/examples/index.md index 53de743..37e9562 100644 --- a/content/site/ja/examples/index.md +++ b/content/site/ja/examples/index.md @@ -1,7 +1,7 @@ # 作例ギャラリー -小さな構成図から始め、グループ、配置、サービスのアイコンへと表現を広げましょう。各プレビューは正本の `.stack` を読み込み、Playgroundと同じWASM engineで端末上に描画します。Engineを更新すれば作例にも反映され、SVG画像の再生成は不要です。 +小さな構成図から始め、グループ、配置、システム全体へと表現を広げましょう。ここに掲載する作例はすべて組み込みアイコンだけで描けるため、追加のパックは不要です。プレビューは正本の `.stack` を読み込み、Playgroundと同じWASM engineで端末上に描画します。 -このギャラリーではサービスのアイコンを組み込みの代替図形で表示します。自分の図でブランドのアイコンを使う場合は、表示されたicon packを[Playground](../guide/provider-icons.md)または[CLI](../guide/getting-started.md)に明示的に取り込んでください。JavaScriptやプレビューを利用できない場合も、ソースへのリンクから原稿を読めます。 +画像をタップすると拡大表示できます。「実寸で見る」で細部を確認したり、画面に合わせて全体を見渡したりできます。別のソースリンクから `.stack` を読んで再利用することもできます。JavaScriptやプレビューを利用できない場合も、ソースへのリンクは利用できます。 diff --git a/content/site/ko/examples/index.md b/content/site/ko/examples/index.md index 5c282f2..664667b 100644 --- a/content/site/ko/examples/index.md +++ b/content/site/ko/examples/index.md @@ -1,7 +1,7 @@ # 예제 갤러리 -작은 다이어그램으로 시작해 그룹, 레이아웃, 제공자 아이콘을 살펴보세요. 각 미리보기는 정본 `.stack` 소스를 불러와 Playground와 같은 WASM 엔진으로 기기에서 렌더링합니다. 엔진이 업데이트되면 미리보기에도 반영되므로 별도의 SVG 이미지를 다시 생성할 필요가 없습니다. +작은 다이어그램으로 시작해 그룹, 레이아웃, 전체 시스템을 살펴보세요. 여기의 모든 예제는 기본 아이콘만 사용하므로 추가 팩이 필요하지 않습니다. 미리보기는 정본 `.stack` 소스를 불러와 Playground와 같은 WASM 엔진으로 기기에서 렌더링합니다. -이 갤러리는 제공자 아이콘에 기본 대체 도형을 사용합니다. 자신의 다이어그램에 브랜드 아이콘을 사용하려면 [Playground](../guide/provider-icons.md) 또는 [CLI](../guide/getting-started.md)에서 표시된 아이콘 팩을 명시적으로 가져오세요. JavaScript나 미리보기를 사용할 수 없어도 소스 링크에서 원문을 읽을 수 있습니다. +이미지를 누르면 확대할 수 있습니다. 실제 크기로 세부 내용을 확인하거나 화면에 맞춰 전체를 보세요. 별도의 소스 링크에서 `.stack` 코드를 읽고 재사용할 수 있으며, JavaScript나 미리보기를 사용할 수 없어도 소스에 접근할 수 있습니다. diff --git a/content/site/zh/examples/index.md b/content/site/zh/examples/index.md index 546ceaf..e514710 100644 --- a/content/site/zh/examples/index.md +++ b/content/site/zh/examples/index.md @@ -1,7 +1,7 @@ # 示例库 -从小型图开始,逐步探索分组、布局和云服务商图标。每个预览都会加载规范的 `.stack` 源码,并使用与 Playground 相同的 WASM 引擎在您的设备上渲染。引擎更新也会改善这些预览,无需重新生成独立的 SVG 图片。 +从小型图开始,逐步探索分组、布局和完整系统。这里的所有示例都只使用内置图标,无需额外的图标包。预览会加载规范的 `.stack` 源码,并使用与 Playground 相同的 WASM 引擎在您的设备上渲染。 -此图库使用内置替代图形显示云服务商图标。要在自己的图中使用品牌图标,请在 [Playground](../guide/provider-icons.md) 或 [CLI](../guide/getting-started.md) 中明确导入页面列出的图标包。即使 JavaScript 或预览加载不可用,您仍可通过链接阅读源码。 +点击图片即可放大。使用实际大小查看细节,或让图表适应屏幕。独立的源码链接可用于阅读和复用 `.stack` 代码;即使 JavaScript 或预览不可用,仍可访问源码。 diff --git a/generated/guide/agent-workflow.md b/generated/guide/agent-workflow.md index d9132a3..fea6bbd 100644 --- a/generated/guide/agent-workflow.md +++ b/generated/guide/agent-workflow.md @@ -6,9 +6,9 @@ Deliver editable `.stack` source and, when rendering is available, an SVG. Prese ## Start with the available tools -Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.1. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. +Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.2. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. -If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. +If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. ## Read only the relevant reference diff --git a/generated/manifest.json b/generated/manifest.json index 89e5293..ab8003e 100644 --- a/generated/manifest.json +++ b/generated/manifest.json @@ -2,21 +2,21 @@ "schemaVersion": "1.0", "cli": { "repository": "stack-sh/cli", - "revision": "1d5f64cc699e42f9ce52ac537903e40c0eb91432", - "version": "0.5.1" + "revision": "f6220c5c24bc515574ea6f6dd6d55af00d35f89d", + "version": "0.5.2" }, "files": [ { "path": "skills/stack-diagrams/SKILL.md", - "sha256": "af399eb4277fa4563f5126cce04e9a4a38feea31880db97c1eb904539a06669c" + "sha256": "70fdcce8810091502b3567a838ca9eb145f3dd9c187d1c51edbc52dd17d0cd0c" }, { "path": "guide/agent-workflow.md", - "sha256": "b92225a66840f094e02ee42f32131f075287044e2d2f0a73ad60335e906ccf86" + "sha256": "c1ce223c9df56e62555909fb58c82928b4a92ff1f157dd2cbc0c03c676bc58f6" }, { "path": "site/examples/index.md", - "sha256": "39074c46d21db23757e0f2a7395f0b5fecd2123ac47e8bcf68bab93219b2f2da" + "sha256": "0843dc907ca300b208f3f1c96b6e1edd07915cbb6efcbe6a4fa5fe84f4e28f43" }, { "path": "site/guide/coding-agents.md", @@ -24,7 +24,7 @@ }, { "path": "site/guide/getting-started.md", - "sha256": "e673678a7fe76d608f290babaf073c57b98fd03fce166c732d86feb50e4c5d8f" + "sha256": "d6356f314f28389119ce31398662c95c8c7ef6ddac60f0bd054ea1f45de757a4" }, { "path": "site/guide/playground.md", @@ -44,7 +44,7 @@ }, { "path": "site/ja/examples/index.md", - "sha256": "f1320c67f8c902f69a8d095e0fdac4baa8ef204768b56f5ed3c0131a55709b73" + "sha256": "3a848161d07ff963e685ee25ff27279f7396e5edd7a334fd236da39d52d4bf69" }, { "path": "site/ja/guide/coding-agents.md", @@ -52,7 +52,7 @@ }, { "path": "site/ja/guide/getting-started.md", - "sha256": "729e59c32a554f6efa6559e6e57811fb494813e8bd68b3e919b90dac7e16bbd6" + "sha256": "aa4bca13cc178bbdb3fb15badfc2d207b79ee0c539acbed92c712120208fa737" }, { "path": "site/ja/guide/playground.md", @@ -100,7 +100,7 @@ }, { "path": "site/ko/examples/index.md", - "sha256": "25a64a9aa5087cf4cdddf968c2f812e0f58b3497c072c01e1b53380f568ba5cf" + "sha256": "f254fb8e71d0b5124e116f6a60370c54b029a9fd832ede3ccb3c1c25935c08f3" }, { "path": "site/ko/guide/coding-agents.md", @@ -108,7 +108,7 @@ }, { "path": "site/ko/guide/getting-started.md", - "sha256": "667080b1012bc67514abe3827d9ff166e7c50dfd0fc7ac3be36d2ef73b801540" + "sha256": "2b3ca8edbf2b8956dae8311283984bbedbf1efee4a60ff38eea74d390b0bd6bc" }, { "path": "site/ko/guide/playground.md", @@ -184,7 +184,7 @@ }, { "path": "site/zh/examples/index.md", - "sha256": "738b43483cbef305b120f351c5a76169c42d669456f2843fe836798a2fb13913" + "sha256": "13e829852b86eab56674ebcfde91b9d143a6c71d4b464e402a693cda7b4514dc" }, { "path": "site/zh/guide/coding-agents.md", @@ -192,7 +192,7 @@ }, { "path": "site/zh/guide/getting-started.md", - "sha256": "2347ab5ddc5196f30287726eac5294b07b81d2c9cf543335751dd62dcc8e1613" + "sha256": "7b6f7d7cdc8264d4633828a21fb1202c3870c9ef6c198c6e23b369214f2abc11" }, { "path": "site/zh/guide/playground.md", @@ -240,19 +240,19 @@ }, { "path": "site/guide/agent-workflow.md", - "sha256": "50e2396e950ae319dbfd26a3dbb06c3a1163cec3cbcb7dac8eb8ca01b618bfd8" + "sha256": "03ed896542fc628227013b7bf69cdc232f77f77a0d630c10f02f27d7b25cefe2" }, { "path": "site/ja/guide/agent-workflow.md", - "sha256": "50e2396e950ae319dbfd26a3dbb06c3a1163cec3cbcb7dac8eb8ca01b618bfd8" + "sha256": "03ed896542fc628227013b7bf69cdc232f77f77a0d630c10f02f27d7b25cefe2" }, { "path": "site/zh/guide/agent-workflow.md", - "sha256": "50e2396e950ae319dbfd26a3dbb06c3a1163cec3cbcb7dac8eb8ca01b618bfd8" + "sha256": "03ed896542fc628227013b7bf69cdc232f77f77a0d630c10f02f27d7b25cefe2" }, { "path": "site/ko/guide/agent-workflow.md", - "sha256": "50e2396e950ae319dbfd26a3dbb06c3a1163cec3cbcb7dac8eb8ca01b618bfd8" + "sha256": "03ed896542fc628227013b7bf69cdc232f77f77a0d630c10f02f27d7b25cefe2" }, { "path": "machine/v1.0.0/manifest.json", diff --git a/generated/site/examples/index.md b/generated/site/examples/index.md index 80967d3..eb1d62a 100644 --- a/generated/site/examples/index.md +++ b/generated/site/examples/index.md @@ -1,7 +1,7 @@ # Example gallery -Start small, then explore groups, layout, and provider icons. Each preview loads a canonical `.stack` source and renders on your device with the same WASM engine as the Playground. Engine updates improve these previews too; no separate SVG images need regeneration. +Start small, then explore groups, layout, and complete systems. Every example here uses built-in icons, so no additional packs are needed. Previews render canonical `.stack` source on your device with the same WASM engine as the Playground. -This gallery uses built-in fallback shapes for provider icons. To use branded artwork in your own diagram, explicitly import the listed icon packs in the [Playground](../guide/provider-icons.md) or [CLI](../guide/getting-started.md). Source links remain available when JavaScript or preview loading is unavailable. +Select an image to enlarge it. Use actual size to inspect details, or fit the diagram to your screen. The separate source link lets you read and reuse the `.stack` code, even when JavaScript or preview loading is unavailable. diff --git a/generated/site/guide/agent-workflow.md b/generated/site/guide/agent-workflow.md index a03738e..afe60af 100644 --- a/generated/site/guide/agent-workflow.md +++ b/generated/site/guide/agent-workflow.md @@ -6,9 +6,9 @@ Deliver editable `.stack` source and, when rendering is available, an SVG. Prese ## Start with the available tools -Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.1. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. +Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.2. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. -If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. +If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. ## Read only the relevant reference diff --git a/generated/site/guide/getting-started.md b/generated/site/guide/getting-started.md index 8464378..2729882 100644 --- a/generated/site/guide/getting-started.md +++ b/generated/site/guide/getting-started.md @@ -4,7 +4,7 @@ Choose one installer, then create your first SVG below. Prefer working in your t ## Install the CLI -Stack CLI 0.5.1 supports macOS and glibc Linux on arm64 and x86_64. Prebuilt archives require macOS 13 or glibc 2.31 or newer; Windows and Alpine/musl are not supported. Choose one installer so different copies do not compete on `PATH`. The [distribution contract](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#supported-platform-matrix) owns the exact support matrix. +Stack CLI 0.5.2 supports macOS and glibc Linux on arm64 and x86_64. Prebuilt archives require macOS 13 or glibc 2.31 or newer; Windows and Alpine/musl are not supported. Choose one installer so different copies do not compete on `PATH`. The [distribution contract](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#supported-platform-matrix) owns the exact support matrix. ### Homebrew @@ -19,7 +19,7 @@ brew install stack-sh/tap/stack Use Rust 1.85 or newer with a native linker: Xcode Command Line Tools on macOS, or a C compiler/linker on Linux. Make sure Cargo’s bin directory is on `PATH`. The package is `stack-diagram-cli`; the installed command is `stack`. ```text -cargo install stack-diagram-cli --version 0.5.1 --locked +cargo install stack-diagram-cli --version 0.5.2 --locked ``` ### Aqua @@ -40,7 +40,7 @@ registries: ref: 42702cda91a4156901b9a601bd143c43dcf05766 path: aqua/registry.yaml packages: - - name: stack-sh/cli@v0.5.1 + - name: stack-sh/cli@v0.5.2 registry: stack-sh ``` @@ -75,7 +75,7 @@ With the [GitHub CLI](https://cli.github.com/) installed and authenticated, run ```text ( set -eu - version=0.5.1 + version=0.5.2 case "$(uname -s)/$(uname -m)" in Darwin/arm64) target=aarch64-apple-darwin ;; Darwin/x86_64) target=x86_64-apple-darwin ;; @@ -113,7 +113,7 @@ $ stack check diagram.stack $ stack render diagram.stack -o diagram.svg ``` -Expected: `stack 0.5.1`, a new `diagram.stack`, no check errors, and a non-empty `diagram.svg`. Open the SVG in a browser or add it to your README. `stack init` protects existing files; use a fresh directory instead of overwriting your work. +Expected: `stack 0.5.2`, a new `diagram.stack`, no check errors, and a non-empty `diagram.svg`. Open the SVG in a browser or add it to your README. `stack init` protects existing files; use a fresh directory instead of overwriting your work. Edit `diagram.stack` to describe your system, then repeat check and render. Format it when needed: diff --git a/generated/site/ja/examples/index.md b/generated/site/ja/examples/index.md index 53de743..37e9562 100644 --- a/generated/site/ja/examples/index.md +++ b/generated/site/ja/examples/index.md @@ -1,7 +1,7 @@ # 作例ギャラリー -小さな構成図から始め、グループ、配置、サービスのアイコンへと表現を広げましょう。各プレビューは正本の `.stack` を読み込み、Playgroundと同じWASM engineで端末上に描画します。Engineを更新すれば作例にも反映され、SVG画像の再生成は不要です。 +小さな構成図から始め、グループ、配置、システム全体へと表現を広げましょう。ここに掲載する作例はすべて組み込みアイコンだけで描けるため、追加のパックは不要です。プレビューは正本の `.stack` を読み込み、Playgroundと同じWASM engineで端末上に描画します。 -このギャラリーではサービスのアイコンを組み込みの代替図形で表示します。自分の図でブランドのアイコンを使う場合は、表示されたicon packを[Playground](../guide/provider-icons.md)または[CLI](../guide/getting-started.md)に明示的に取り込んでください。JavaScriptやプレビューを利用できない場合も、ソースへのリンクから原稿を読めます。 +画像をタップすると拡大表示できます。「実寸で見る」で細部を確認したり、画面に合わせて全体を見渡したりできます。別のソースリンクから `.stack` を読んで再利用することもできます。JavaScriptやプレビューを利用できない場合も、ソースへのリンクは利用できます。 diff --git a/generated/site/ja/guide/agent-workflow.md b/generated/site/ja/guide/agent-workflow.md index a03738e..afe60af 100644 --- a/generated/site/ja/guide/agent-workflow.md +++ b/generated/site/ja/guide/agent-workflow.md @@ -6,9 +6,9 @@ Deliver editable `.stack` source and, when rendering is available, an SVG. Prese ## Start with the available tools -Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.1. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. +Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.2. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. -If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. +If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. ## Read only the relevant reference diff --git a/generated/site/ja/guide/getting-started.md b/generated/site/ja/guide/getting-started.md index ccd197b..d7f6f6d 100644 --- a/generated/site/ja/guide/getting-started.md +++ b/generated/site/ja/guide/getting-started.md @@ -4,7 +4,7 @@ ## CLIを導入する -Stack CLI 0.5.1はarm64 / x86_64のmacOSとglibc Linuxに対応します。配布バイナリーの要件はmacOS 13以降またはglibc 2.31以降です。WindowsとAlpine/muslは対象外です。`PATH`上で複数のバイナリーが競合しないよう、導入方法を1つ選んでください。正確な対応表は[配布契約](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#supported-platform-matrix)が正本です。 +Stack CLI 0.5.2はarm64 / x86_64のmacOSとglibc Linuxに対応します。配布バイナリーの要件はmacOS 13以降またはglibc 2.31以降です。WindowsとAlpine/muslは対象外です。`PATH`上で複数のバイナリーが競合しないよう、導入方法を1つ選んでください。正確な対応表は[配布契約](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#supported-platform-matrix)が正本です。 ### Homebrew @@ -19,7 +19,7 @@ brew install stack-sh/tap/stack Rust 1.85以降とネイティブリンカーが必要です。macOSではXcode Command Line Tools、LinuxではCコンパイラーとリンカーを用意し、Cargoのbinディレクトリを`PATH`へ追加してください。パッケージ名は`stack-diagram-cli`、コマンド名は`stack`です。 ```text -cargo install stack-diagram-cli --version 0.5.1 --locked +cargo install stack-diagram-cli --version 0.5.2 --locked ``` ### Aqua @@ -40,7 +40,7 @@ registries: ref: 42702cda91a4156901b9a601bd143c43dcf05766 path: aqua/registry.yaml packages: - - name: stack-sh/cli@v0.5.1 + - name: stack-sh/cli@v0.5.2 registry: stack-sh ``` @@ -75,7 +75,7 @@ aqua install ```text ( set -eu - version=0.5.1 + version=0.5.2 case "$(uname -s)/$(uname -m)" in Darwin/arm64) target=aarch64-apple-darwin ;; Darwin/x86_64) target=x86_64-apple-darwin ;; @@ -113,7 +113,7 @@ $ stack check diagram.stack $ stack render diagram.stack -o diagram.svg ``` -`stack 0.5.1`と表示され、`diagram.stack`が作成され、checkがエラーなく終了し、空でない`diagram.svg`ができれば成功です。SVGはブラウザーで開いたりREADMEに貼ったりできます。`stack init`は既存ファイルを保護するため、上書きせず新しいディレクトリを使ってください。 +`stack 0.5.2`と表示され、`diagram.stack`が作成され、checkがエラーなく終了し、空でない`diagram.svg`ができれば成功です。SVGはブラウザーで開いたりREADMEに貼ったりできます。`stack init`は既存ファイルを保護するため、上書きせず新しいディレクトリを使ってください。 `diagram.stack`を自分の構成に書き換え、checkとrenderを繰り返します。整形が必要な場合は次を実行します。 diff --git a/generated/site/ko/examples/index.md b/generated/site/ko/examples/index.md index 5c282f2..664667b 100644 --- a/generated/site/ko/examples/index.md +++ b/generated/site/ko/examples/index.md @@ -1,7 +1,7 @@ # 예제 갤러리 -작은 다이어그램으로 시작해 그룹, 레이아웃, 제공자 아이콘을 살펴보세요. 각 미리보기는 정본 `.stack` 소스를 불러와 Playground와 같은 WASM 엔진으로 기기에서 렌더링합니다. 엔진이 업데이트되면 미리보기에도 반영되므로 별도의 SVG 이미지를 다시 생성할 필요가 없습니다. +작은 다이어그램으로 시작해 그룹, 레이아웃, 전체 시스템을 살펴보세요. 여기의 모든 예제는 기본 아이콘만 사용하므로 추가 팩이 필요하지 않습니다. 미리보기는 정본 `.stack` 소스를 불러와 Playground와 같은 WASM 엔진으로 기기에서 렌더링합니다. -이 갤러리는 제공자 아이콘에 기본 대체 도형을 사용합니다. 자신의 다이어그램에 브랜드 아이콘을 사용하려면 [Playground](../guide/provider-icons.md) 또는 [CLI](../guide/getting-started.md)에서 표시된 아이콘 팩을 명시적으로 가져오세요. JavaScript나 미리보기를 사용할 수 없어도 소스 링크에서 원문을 읽을 수 있습니다. +이미지를 누르면 확대할 수 있습니다. 실제 크기로 세부 내용을 확인하거나 화면에 맞춰 전체를 보세요. 별도의 소스 링크에서 `.stack` 코드를 읽고 재사용할 수 있으며, JavaScript나 미리보기를 사용할 수 없어도 소스에 접근할 수 있습니다. diff --git a/generated/site/ko/guide/agent-workflow.md b/generated/site/ko/guide/agent-workflow.md index a03738e..afe60af 100644 --- a/generated/site/ko/guide/agent-workflow.md +++ b/generated/site/ko/guide/agent-workflow.md @@ -6,9 +6,9 @@ Deliver editable `.stack` source and, when rendering is available, an SVG. Prese ## Start with the available tools -Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.1. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. +Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.2. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. -If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. +If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. ## Read only the relevant reference diff --git a/generated/site/ko/guide/getting-started.md b/generated/site/ko/guide/getting-started.md index 081504e..c0026e1 100644 --- a/generated/site/ko/guide/getting-started.md +++ b/generated/site/ko/guide/getting-started.md @@ -4,7 +4,7 @@ ## CLI 설치 -Stack CLI 0.5.1은 arm64 / x86_64 macOS와 glibc Linux를 지원합니다. 미리 빌드된 파일은 macOS 13 또는 glibc 2.31 이상이 필요하며 Windows와 Alpine/musl은 지원하지 않습니다. 여러 바이너리가 `PATH`에서 충돌하지 않도록 설치 방법 하나를 선택하세요. 정확한 지원 범위는 [배포 계약](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#supported-platform-matrix)이 정합니다. +Stack CLI 0.5.2은 arm64 / x86_64 macOS와 glibc Linux를 지원합니다. 미리 빌드된 파일은 macOS 13 또는 glibc 2.31 이상이 필요하며 Windows와 Alpine/musl은 지원하지 않습니다. 여러 바이너리가 `PATH`에서 충돌하지 않도록 설치 방법 하나를 선택하세요. 정확한 지원 범위는 [배포 계약](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#supported-platform-matrix)이 정합니다. ### Homebrew @@ -19,7 +19,7 @@ brew install stack-sh/tap/stack Rust 1.85 이상과 네이티브 링커가 필요합니다. macOS는 Xcode Command Line Tools, Linux는 C 컴파일러와 링커를 준비하세요. Cargo의 bin 디렉터리를 `PATH`에 추가하세요. 패키지 이름은 `stack-diagram-cli`, 설치되는 명령은 `stack`입니다. ```text -cargo install stack-diagram-cli --version 0.5.1 --locked +cargo install stack-diagram-cli --version 0.5.2 --locked ``` ### Aqua @@ -40,7 +40,7 @@ registries: ref: 42702cda91a4156901b9a601bd143c43dcf05766 path: aqua/registry.yaml packages: - - name: stack-sh/cli@v0.5.1 + - name: stack-sh/cli@v0.5.2 registry: stack-sh ``` @@ -75,7 +75,7 @@ aqua install ```text ( set -eu - version=0.5.1 + version=0.5.2 case "$(uname -s)/$(uname -m)" in Darwin/arm64) target=aarch64-apple-darwin ;; Darwin/x86_64) target=x86_64-apple-darwin ;; @@ -113,7 +113,7 @@ $ stack check diagram.stack $ stack render diagram.stack -o diagram.svg ``` -`stack 0.5.1`이 표시되고 `diagram.stack`이 생성되며 오류 없이 검사되고 비어 있지 않은 `diagram.svg`가 만들어지면 성공입니다. SVG를 브라우저에서 열거나 README에 넣으세요. `stack init`은 기존 파일을 보호하므로 덮어쓰는 대신 새 디렉터리를 사용하세요. +`stack 0.5.2`이 표시되고 `diagram.stack`이 생성되며 오류 없이 검사되고 비어 있지 않은 `diagram.svg`가 만들어지면 성공입니다. SVG를 브라우저에서 열거나 README에 넣으세요. `stack init`은 기존 파일을 보호하므로 덮어쓰는 대신 새 디렉터리를 사용하세요. `diagram.stack`을 자신의 시스템에 맞게 수정하고 check와render를 반복하세요. 필요할 때 다음 명령으로 포맷하세요. diff --git a/generated/site/zh/examples/index.md b/generated/site/zh/examples/index.md index 546ceaf..e514710 100644 --- a/generated/site/zh/examples/index.md +++ b/generated/site/zh/examples/index.md @@ -1,7 +1,7 @@ # 示例库 -从小型图开始,逐步探索分组、布局和云服务商图标。每个预览都会加载规范的 `.stack` 源码,并使用与 Playground 相同的 WASM 引擎在您的设备上渲染。引擎更新也会改善这些预览,无需重新生成独立的 SVG 图片。 +从小型图开始,逐步探索分组、布局和完整系统。这里的所有示例都只使用内置图标,无需额外的图标包。预览会加载规范的 `.stack` 源码,并使用与 Playground 相同的 WASM 引擎在您的设备上渲染。 -此图库使用内置替代图形显示云服务商图标。要在自己的图中使用品牌图标,请在 [Playground](../guide/provider-icons.md) 或 [CLI](../guide/getting-started.md) 中明确导入页面列出的图标包。即使 JavaScript 或预览加载不可用,您仍可通过链接阅读源码。 +点击图片即可放大。使用实际大小查看细节,或让图表适应屏幕。独立的源码链接可用于阅读和复用 `.stack` 代码;即使 JavaScript 或预览不可用,仍可访问源码。 diff --git a/generated/site/zh/guide/agent-workflow.md b/generated/site/zh/guide/agent-workflow.md index a03738e..afe60af 100644 --- a/generated/site/zh/guide/agent-workflow.md +++ b/generated/site/zh/guide/agent-workflow.md @@ -6,9 +6,9 @@ Deliver editable `.stack` source and, when rendering is available, an SVG. Prese ## Start with the available tools -Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.1. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. +Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.2. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. -If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. +If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. ## Read only the relevant reference diff --git a/generated/site/zh/guide/getting-started.md b/generated/site/zh/guide/getting-started.md index 4f943f1..700000c 100644 --- a/generated/site/zh/guide/getting-started.md +++ b/generated/site/zh/guide/getting-started.md @@ -4,7 +4,7 @@ ## 安装CLI -Stack CLI 0.5.1支持arm64 / x86_64的macOS和glibc Linux。预编译文件需要macOS 13或glibc 2.31及以上;不支持Windows和Alpine/musl。请选择一种安装方式,避免多个二进制文件在`PATH`中冲突。准确的支持范围以[分发契约](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#supported-platform-matrix)为准。 +Stack CLI 0.5.2支持arm64 / x86_64的macOS和glibc Linux。预编译文件需要macOS 13或glibc 2.31及以上;不支持Windows和Alpine/musl。请选择一种安装方式,避免多个二进制文件在`PATH`中冲突。准确的支持范围以[分发契约](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#supported-platform-matrix)为准。 ### Homebrew @@ -19,7 +19,7 @@ brew install stack-sh/tap/stack 需要Rust 1.85及以上和本地链接器:macOS使用Xcode Command Line Tools,Linux使用C编译器和链接器。将Cargo的bin目录加入`PATH`。包名为`stack-diagram-cli`,安装后的命令为`stack`。 ```text -cargo install stack-diagram-cli --version 0.5.1 --locked +cargo install stack-diagram-cli --version 0.5.2 --locked ``` ### Aqua @@ -40,7 +40,7 @@ registries: ref: 42702cda91a4156901b9a601bd143c43dcf05766 path: aqua/registry.yaml packages: - - name: stack-sh/cli@v0.5.1 + - name: stack-sh/cli@v0.5.2 registry: stack-sh ``` @@ -75,7 +75,7 @@ aqua install ```text ( set -eu - version=0.5.1 + version=0.5.2 case "$(uname -s)/$(uname -m)" in Darwin/arm64) target=aarch64-apple-darwin ;; Darwin/x86_64) target=x86_64-apple-darwin ;; @@ -113,7 +113,7 @@ $ stack check diagram.stack $ stack render diagram.stack -o diagram.svg ``` -预期结果:显示`stack 0.5.1`、生成`diagram.stack`、检查无错误,并生成非空的`diagram.svg`。用浏览器打开SVG或将其加入README。`stack init`会保护已有文件,请使用新目录而非覆盖原有工作。 +预期结果:显示`stack 0.5.2`、生成`diagram.stack`、检查无错误,并生成非空的`diagram.svg`。用浏览器打开SVG或将其加入README。`stack init`会保护已有文件,请使用新目录而非覆盖原有工作。 修改`diagram.stack`描述自己的系统,再次运行check和render。需要格式化时执行: diff --git a/generated/skills/stack-diagrams/SKILL.md b/generated/skills/stack-diagrams/SKILL.md index 1677899..5b404a4 100644 --- a/generated/skills/stack-diagrams/SKILL.md +++ b/generated/skills/stack-diagrams/SKILL.md @@ -12,9 +12,9 @@ Deliver editable `.stack` source and, when rendering is available, an SVG. Prese ## Start with the available tools -Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.1. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. +Run `stack --version` and `stack help` before selecting commands. Use the installed binary's help, not unreleased repository instructions. This workflow is tested with published CLI 0.5.2. The commands below use human-readable output; `check`, `fmt`, and `render` also accept `--json` for structured diagnostics, artifacts, and operational errors. Read the [versioned JSON output contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/machine-readable-output.md) before parsing it, and verify options using `stack help `. -If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.1/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. +If the CLI is missing, consult the [installation guide](https://stack-diagram.com/docs/guide/getting-started.md) and [release distribution contract](https://github.com/stack-sh/cli/blob/v0.5.2/docs/distribution.md). Install only when the user's authorization allows it. Otherwise provide source with an explicit validation gap; do not report it as checked. No remote source upload is required. Upgrade with the package manager that installed Stack, or verify and manually replace a direct download; `stack update` has been removed. For local configuration problems, `stack doctor` and `stack config path` provide read-only diagnosis. ## Read only the relevant reference diff --git a/package-lock.json b/package-lock.json index 5273d4b..5946a1a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,14 +9,14 @@ "version": "0.1.0", "license": "Apache-2.0", "devDependencies": { - "@stack-sh/engine": "0.7.0", + "@stack-sh/engine": "0.8.0", "ajv": "8.20.0" } }, "node_modules/@stack-sh/engine": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/@stack-sh/engine/-/engine-0.7.0.tgz", - "integrity": "sha512-Y6HCbiNHfdyqD1TEsDy3kNNtiswy7DPCHInYHUdrExjAW/GeeCLigYjHqLtUlXVmE/ppRpKxThZOOhy2sUQL5g==", + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/@stack-sh/engine/-/engine-0.8.0.tgz", + "integrity": "sha512-nGZtxpH8Ca5j+1TW0dmlPQHDRynoUYcq1CaQ65DlyWc+ImmEbWEiRo6OiwXDN1tqaALN2a2TLkFpCSYW+fu/sA==", "dev": true, "license": "Apache-2.0" }, diff --git a/package.json b/package.json index a40a338..1be5e80 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ "smoke": "node scripts/smoke-skill.mjs && node scripts/first-render.mjs" }, "devDependencies": { - "@stack-sh/engine": "0.7.0", + "@stack-sh/engine": "0.8.0", "ajv": "8.20.0" } }