stylegallery 0.1.4 → 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/DOMAINS.md +11 -9
- package/GOVERNANCE.md +8 -2
- package/LICENSE +28 -0
- package/LICENSE-DOCS +42 -0
- package/NOTICE +38 -0
- package/README.md +43 -6
- package/consumer-reference/agent-native/README.md +7 -7
- package/consumer-reference/agent-native/v2/admission-policy.json +241 -1
- package/consumer-reference/agent-native/v2/material-registry.json +1 -1
- package/consumer-reference/agent-native/v2/schema/admission-policy.schema.json +2 -2
- package/design-engineering/component-contract.md +114 -0
- package/design-engineering/decision-tree.md +70 -0
- package/design-engineering/index.md +60 -2
- package/design-engineering/loading-and-feedback.md +91 -0
- package/design-engineering/native-interaction-contracts.md +94 -0
- package/design-engineering/state-management/decision-tree.md +60 -0
- package/design-engineering/state-management/index.md +61 -0
- package/design-engineering/state-management/patterns/derived-state.md +85 -0
- package/design-engineering/state-management/patterns/draft-and-baseline.md +86 -0
- package/design-engineering/state-management/patterns/id-selection.md +85 -0
- package/design-engineering/state-management/patterns/identity-reset.md +89 -0
- package/design-engineering/state-management/patterns/latest-request-wins.md +94 -0
- package/design-engineering/state-management/patterns/optimistic-overlay.md +98 -0
- package/design-engineering/state-management/patterns/single-flight.md +92 -0
- package/design-engineering/state-management/patterns/single-owner.md +89 -0
- package/design-engineering/state-management/patterns/submitted-snapshot.md +107 -0
- package/design-engineering/state-management/patterns/unsaved-navigation.md +100 -0
- package/design-engineering/state-management/patterns/url-state.md +96 -0
- package/design-engineering/state-management/patterns/versioned-restore.md +95 -0
- package/design-engineering/state-management/recipes/delete-undo.md +65 -0
- package/design-engineering/state-management/recipes/index.md +64 -0
- package/design-engineering/state-management/recipes/multi-step-form.md +65 -0
- package/design-engineering/state-management/recipes/search-detail.md +65 -0
- package/design-engineering/state-management/recipes/settings-save.md +64 -0
- package/design-engineering/state-management/state-brief.md +83 -0
- package/design-engineering/state-management/verification.md +65 -0
- package/design-engineering/text-input-and-internationalization.md +91 -0
- package/design-engineering/worked-examples.md +129 -0
- package/design-terminology/comparison-workflow.md +98 -0
- package/design-terminology/conflict-cases.md +87 -55
- package/design-terminology/index.md +19 -5
- package/design-terminology/interaction-semantics.md +87 -0
- package/design-terminology/relation-types.md +12 -6
- package/design-terminology/source-vocabularies.md +33 -3
- package/design-terminology/token-semantics.md +90 -0
- package/design-terminology/typography-semantics.md +86 -0
- package/game-ui/decision-tree.md +81 -0
- package/game-ui/index.md +11 -1
- package/game-ui/screen-recipes.md +101 -0
- package/game-ui/verification-workflow.md +100 -0
- package/index.md +8 -0
- package/log.md +67 -0
- package/motion/accessible-motion.md +90 -0
- package/motion/decision-tree.md +70 -0
- package/motion/index.md +21 -2
- package/motion/interaction-recipes.md +170 -0
- package/motion/interruption-and-retargeting.md +90 -0
- package/motion/motion-brief.md +125 -0
- package/motion/observed-choreography.md +73 -0
- package/motion/rendering-and-performance.md +89 -0
- package/motion/review-workflow.md +8 -0
- package/motion/vocabulary.md +2 -2
- package/package.json +74 -8
- package/platform-guides/adaptation-workflow.md +76 -0
- package/platform-guides/adaptive-navigation.md +85 -0
- package/platform-guides/android-interaction.md +74 -0
- package/platform-guides/apple-interaction.md +9 -1
- package/platform-guides/compatibility-matrix.md +97 -0
- package/platform-guides/index.md +19 -2
- package/platform-guides/input-and-focus.md +91 -0
- package/platform-guides/preferences-and-accessibility.md +90 -0
- package/platform-guides/windows-interaction.md +75 -0
- package/recipes/homepage.md +8 -0
- package/scripts/compiler/README.md +112 -0
- package/scripts/compiler/cli.mjs +51 -0
- package/scripts/compiler/mcp.mjs +53 -0
- package/scripts/compiler/operations.mjs +70 -0
- package/scripts/compiler/runtime.mjs +156 -0
- package/scripts/sg-entry.mjs +20 -0
- package/scripts/sg-server.mjs +20 -0
package/DOMAINS.md
CHANGED
|
@@ -26,11 +26,11 @@ This manifest is the source of truth for top-level StyleGallery domains. A domai
|
|
|
26
26
|
| Domain | Manual hub | Governed leaves |
|
|
27
27
|
| --- | --- | --- |
|
|
28
28
|
| Layout | `layout/index.md` | Existing `GUIDE.md`, Layout-specific `guides/*.md`, and `recipes/*.md`; generated `patterns/**/*.md` and `CATALOG.md` remain at current paths. Shared `quality/**/*.md` infrastructure governs every domain without becoming a Layout leaf. |
|
|
29
|
-
| Motion | `motion/index.md` | `motion/vocabulary.md`, `motion/review-workflow.md`, `motion/practice-reference.md` |
|
|
30
|
-
| Design Engineering | `design-engineering/index.md` | `design-engineering/interface-craft.md`, `design-engineering/consumer-migration-readiness.md`, `design-engineering/reference-profiles/index.md`, `design-engineering/reference-profiles/governed-local/index.md`, `design-engineering/reference-profiles/external-adaptation/index.md` |
|
|
31
|
-
| Game UI | `game-ui/index.md` | `game-ui/classification.md`, `game-ui/screen-hierarchy.md`, `game-ui/reference-record.md`, `game-ui/unity/architecture.md`, `game-ui/unity/ui-systems.md`, `game-ui/unity/cli-loop.md`, `game-ui/unity/repository-map.md`, `game-ui/unity/org-wiki.md` |
|
|
32
|
-
| Platform Guides | `platform-guides/index.md` | `platform-guides/apple-interaction.md` |
|
|
33
|
-
| Design Terminology | `design-terminology/index.md` | `design-terminology/source-kinds.md`, `design-terminology/source-vocabularies.md`, `design-terminology/concept-families.md`, `design-terminology/relation-types.md`, `design-terminology/conflict-cases.md` |
|
|
29
|
+
| Motion | `motion/index.md` | `motion/vocabulary.md`, `motion/review-workflow.md`, `motion/practice-reference.md`, `motion/decision-tree.md`, `motion/motion-brief.md`, `motion/interaction-recipes.md`, `motion/observed-choreography.md`, `motion/accessible-motion.md`, `motion/interruption-and-retargeting.md`, `motion/rendering-and-performance.md` |
|
|
30
|
+
| Design Engineering | `design-engineering/index.md` | `design-engineering/interface-craft.md`, `design-engineering/consumer-migration-readiness.md`, `design-engineering/reference-profiles/index.md`, `design-engineering/reference-profiles/governed-local/index.md`, `design-engineering/reference-profiles/external-adaptation/index.md`, `design-engineering/decision-tree.md`, `design-engineering/component-contract.md`, `design-engineering/worked-examples.md`, `design-engineering/state-management/decision-tree.md`, `design-engineering/state-management/index.md`, `design-engineering/state-management/patterns/derived-state.md`, `design-engineering/state-management/patterns/draft-and-baseline.md`, `design-engineering/state-management/patterns/id-selection.md`, `design-engineering/state-management/patterns/identity-reset.md`, `design-engineering/state-management/patterns/latest-request-wins.md`, `design-engineering/state-management/patterns/optimistic-overlay.md`, `design-engineering/state-management/patterns/single-flight.md`, `design-engineering/state-management/patterns/single-owner.md`, `design-engineering/state-management/patterns/submitted-snapshot.md`, `design-engineering/state-management/patterns/unsaved-navigation.md`, `design-engineering/state-management/patterns/url-state.md`, `design-engineering/state-management/patterns/versioned-restore.md`, `design-engineering/state-management/recipes/delete-undo.md`, `design-engineering/state-management/recipes/index.md`, `design-engineering/state-management/recipes/multi-step-form.md`, `design-engineering/state-management/recipes/search-detail.md`, `design-engineering/state-management/recipes/settings-save.md`, `design-engineering/state-management/state-brief.md`, `design-engineering/state-management/verification.md`, `design-engineering/native-interaction-contracts.md`, `design-engineering/text-input-and-internationalization.md`, `design-engineering/loading-and-feedback.md` |
|
|
31
|
+
| Game UI | `game-ui/index.md` | `game-ui/classification.md`, `game-ui/screen-hierarchy.md`, `game-ui/reference-record.md`, `game-ui/unity/architecture.md`, `game-ui/unity/ui-systems.md`, `game-ui/unity/cli-loop.md`, `game-ui/unity/repository-map.md`, `game-ui/unity/org-wiki.md`, `game-ui/decision-tree.md`, `game-ui/screen-recipes.md`, `game-ui/verification-workflow.md` |
|
|
32
|
+
| Platform Guides | `platform-guides/index.md` | `platform-guides/apple-interaction.md`, `platform-guides/adaptation-workflow.md`, `platform-guides/android-interaction.md`, `platform-guides/windows-interaction.md`, `platform-guides/compatibility-matrix.md`, `platform-guides/adaptive-navigation.md`, `platform-guides/preferences-and-accessibility.md`, `platform-guides/input-and-focus.md` |
|
|
33
|
+
| Design Terminology | `design-terminology/index.md` | `design-terminology/source-kinds.md`, `design-terminology/source-vocabularies.md`, `design-terminology/concept-families.md`, `design-terminology/relation-types.md`, `design-terminology/conflict-cases.md`, `design-terminology/comparison-workflow.md`, `design-terminology/token-semantics.md`, `design-terminology/interaction-semantics.md`, `design-terminology/typography-semantics.md` |
|
|
34
34
|
|
|
35
35
|
## Shared Non-Domain Infrastructure
|
|
36
36
|
|
|
@@ -47,15 +47,17 @@ The initial five domain leaves are independent method rewrites inspired by [emil
|
|
|
47
47
|
- If recognizable upstream expression is added later, preserve the full upstream MIT notice and record the copied material separately before merge.
|
|
48
48
|
- Tracked repository documents must not depend on `.omo/`; stable upstream blob links and tracked repository contracts carry contributor-facing provenance.
|
|
49
49
|
|
|
50
|
-
|
|
50
|
+
The workflow, brief, contract, recipe, and comparison leaves added under the five non-Layout domains are StyleGallery-local synthesis with `provenance_kind: local`; their worked scenarios are proposals, not captured product evidence. The domain indexes route selection, authoring, application, and verification.
|
|
51
51
|
|
|
52
|
-
|
|
52
|
+
`design-engineering/consumer-migration-readiness.md` is a separately declared StyleGallery-local leaf. It uses `provenance_kind: local`, carries no external source fields, and remains experimental. Its presence does not change the external-adaptation inventory or make its consumer-local method universal policy.
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
## Lifecycle And Staleness
|
|
55
|
+
|
|
56
|
+
External adaptations begin `experimental`. Domain lifecycle changes are repository-owner decisions based on whether the bounded scope remains coherent, provenance and platform-version obligations are current, and machine-checkable contracts have relevant validator coverage. User studies, reader tasks, adoption counts, and attestations are neither required nor sufficient for a domain lifecycle change. Remove or revise a page when its source revision changes materially, a platform claim becomes stale, a local quality gate contradicts it, or its route or boundary no longer matches the domain contract.
|
|
55
57
|
|
|
56
58
|
### Consumer Reference Promotion
|
|
57
59
|
|
|
58
|
-
Consumer-reference promotion does not add a domain. The [canonical promotion contract](consumer-reference/contract.md#promotion-boundary) owns the full human-readable boundary, and the [canonical JSON promotion policy](consumer-reference/policies/shared-experimental.json) owns machine policy. As a boundary summary: the `>=2` gateway applies only to consumer-local → shared-experimental invariant eligibility; Editorial and terminal are related examples in one fixture set; Shared stable has no numeric adoption threshold; and Normative correctness may waive adoption count only. A failed stable contract is never silently relabeled experimental. Promotion records are JSON-only, and the committed examples remain synthetic with zero adopter attestations.
|
|
60
|
+
This separate contract governs consumer-reference invariant sharing only; it does not govern domain or page lifecycle. Consumer-reference promotion does not add a domain. The [canonical promotion contract](consumer-reference/contract.md#promotion-boundary) owns the full human-readable boundary, and the [canonical JSON promotion policy](consumer-reference/policies/shared-experimental.json) owns machine policy. As a boundary summary: the `>=2` gateway applies only to consumer-local → shared-experimental invariant eligibility; Editorial and terminal are related examples in one fixture set; Shared stable has no numeric adoption threshold; and Normative correctness may waive adoption count only. A failed stable contract is never silently relabeled experimental. Promotion records are JSON-only, and the committed examples remain synthetic with zero adopter attestations.
|
|
59
61
|
|
|
60
62
|
## IA Navigation
|
|
61
63
|
|
package/GOVERNANCE.md
CHANGED
|
@@ -39,15 +39,21 @@ Use this file before editing repository documentation. It names which file is au
|
|
|
39
39
|
| Domain manifest and scope decision | `DOMAINS.md`, `quality/claim-records/stylegallery-multidomain-scope.md` | Manual | None | `stable` | Domain membership, repository-scope, or provenance-policy changes. | `scripts/validate-domains.mjs`, `scripts/validate-governance.mjs` | Repository governance owner |
|
|
40
40
|
| Layout domain hub | `layout/index.md` | Manual | None | `stable` | Layout route or ownership changes. | `scripts/validate-domains.mjs`, `scripts/validate-ia.mjs` | Pattern-data owner |
|
|
41
41
|
| Motion domain guidance | `motion/*.md` | Manual | None | `experimental` | Upstream revision, evidence boundary, or guidance changes. | `scripts/validate-domains.mjs` | Motion domain owner |
|
|
42
|
-
| Design Engineering domain guidance | `design-engineering/*.md` | Manual | None | `experimental` | Upstream revision, evidence boundary, or guidance changes. | `scripts/validate-domains.mjs` | Design Engineering domain owner |
|
|
42
|
+
| Design Engineering domain guidance | `design-engineering/*.md`, `design-engineering/state-management/**/*.md` | Manual | None | `experimental` | Upstream revision, evidence boundary, or guidance changes. | `scripts/validate-domains.mjs` | Design Engineering domain owner |
|
|
43
43
|
| Game UI domain guidance | `game-ui/**/*.md` | Manual | None | `experimental` | Classification, hierarchy, engine implementation, evidence boundary, or route changes. | `scripts/validate-domains.mjs` | Game UI domain owner |
|
|
44
44
|
| Platform Guides domain guidance | `platform-guides/*.md` | Manual | None | `experimental` | Platform version, upstream revision, evidence boundary, or guidance changes. | `scripts/validate-domains.mjs` | Platform Guides domain owner |
|
|
45
|
-
| Design Terminology domain guidance | `design-terminology/*.md` | Manual | None | `experimental` | Source-kind, source-vocabulary, concept-family, relation-model, or conflict-case changes. | `scripts/validate-domains.mjs`, `scripts/validate-design-terminology.mjs` | Design Terminology domain owner |
|
|
45
|
+
| Design Terminology domain guidance | `design-terminology/*.md` | Manual; term and relation tables remain authoring sources | None | `experimental` | Source-kind, source-vocabulary, concept-family, relation-model, or conflict-case changes. | `scripts/validate-domains.mjs`, `scripts/validate-design-terminology.mjs` | Design Terminology domain owner |
|
|
46
46
|
| Pattern data and examples | `scripts/pattern-data.mjs` | Manual data source | `patterns/**/*.md`, `patterns/**/index.md`, `patterns/index.md`, `CATALOG.md` | `generated` output from `stable` source | Source-lineage URL changes, generated drift, category changes, or pattern count changes. | `scripts/validate-patterns.mjs`, `scripts/validate-catalog.mjs`, `scripts/validate-governance.mjs` | Pattern-data owner |
|
|
47
47
|
| Pattern generator | `scripts/generate-patterns.mjs` | Manual code source | `patterns/**/*.md`, `patterns/**/index.md`, `patterns/index.md`, `CATALOG.md` | `stable` generator, `generated` output | Generated structure changes, generated-warning changes, or generated metadata changes. | `node -c scripts/generate-patterns.mjs`, generated drift check, `scripts/validate-governance.mjs` | Pattern-data owner |
|
|
48
48
|
| Validation scripts | `scripts/validate-*.mjs`, `scripts/test-validate-*.mjs` | Manual code source | CI validation output | `stable` | Validator scope changes, fixture changes, or CI parity changes. | `node -c`, matching fixture tests, `.github/workflows/validate.yml` | Validation owner |
|
|
49
49
|
| CI workflows | `.github/workflows/validate.yml`, `.github/workflows/evidence-freshness.yml` | Manual | GitHub Actions runs and audit artifacts | `stable` | Validation step, explicit-deadline schedule, generated drift policy, or owner changes. | GitHub Actions, `scripts/validate-governance.mjs` | Repository governance owner |
|
|
50
50
|
|
|
51
|
+
## Domain Workflow Verification Boundary
|
|
52
|
+
|
|
53
|
+
The non-Layout hubs route selection, briefs/contracts, applied recipes or cases, and verification. Their local leaves declare `provenance_kind: local` and remain `experimental`. Worked examples contain expected outcomes, not captured product or engine evidence. `scripts/validate-domains.mjs` checks declared membership, provenance, sections, and routes; it does not execute those examples.
|
|
54
|
+
|
|
55
|
+
The Design Terminology Markdown tables additionally require directly located sources, labels, valid dates, explicit comparison scope and direction, and consistent relation graphs. `scripts/validate-design-terminology.mjs` and its negative fixtures check those record invariants; semantic accuracy and independent promotion review remain human judgments. Material v2 indexes only the admitted Markdown bytes. Changing the allowed document set requires updating its closed inventory, digest, package exposure, and generated registry together, without admitting code, schemas, profiles, or fixtures as material.
|
|
56
|
+
|
|
51
57
|
## Generated Artifact Policy
|
|
52
58
|
|
|
53
59
|
Generated files are not source of truth. Do not hand-edit generated artifacts to change pattern content or catalog structure.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 IYEN
|
|
4
|
+
|
|
5
|
+
This license applies to the source code in this repository: scripts, CLI and
|
|
6
|
+
MCP server implementations, the website and server code under `site/`,
|
|
7
|
+
validators, and test code. The Markdown documentation, pattern and recipe
|
|
8
|
+
prose, and domain documents are licensed separately under CC BY 4.0; see
|
|
9
|
+
LICENSE-DOCS. Third-party material adapted into this repository keeps its
|
|
10
|
+
original rights; see NOTICE.
|
|
11
|
+
|
|
12
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
13
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
14
|
+
in the Software without restriction, including without limitation the rights
|
|
15
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
16
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
17
|
+
furnished to do so, subject to the following conditions:
|
|
18
|
+
|
|
19
|
+
The above copyright notice and this permission notice shall be included in all
|
|
20
|
+
copies or substantial portions of the Software.
|
|
21
|
+
|
|
22
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
23
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
24
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
25
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
26
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
27
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
28
|
+
SOFTWARE.
|
package/LICENSE-DOCS
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
Creative Commons Attribution 4.0 International (CC BY 4.0)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 IYEN
|
|
4
|
+
|
|
5
|
+
This license applies to the documentation in this repository: the Markdown
|
|
6
|
+
documents of the Layout, Motion, Design Engineering, Game UI, Platform Guides,
|
|
7
|
+
and Design Terminology domains, including `patterns/`, `recipes/`, `guides/`,
|
|
8
|
+
`GUIDE.md`, `CATALOG.md`, the domain index and contract documents, the
|
|
9
|
+
observation transcription formats, and the generated documentation under
|
|
10
|
+
`site/` that is derived from them.
|
|
11
|
+
|
|
12
|
+
It does not apply to source code (see LICENSE, MIT), and it does not apply to
|
|
13
|
+
material adapted from third-party sources, which keeps its original rights
|
|
14
|
+
(see NOTICE).
|
|
15
|
+
|
|
16
|
+
You are free to:
|
|
17
|
+
|
|
18
|
+
Share - copy and redistribute the material in any medium or format for any
|
|
19
|
+
purpose, even commercially.
|
|
20
|
+
Adapt - remix, transform, and build upon the material for any purpose, even
|
|
21
|
+
commercially.
|
|
22
|
+
|
|
23
|
+
Under the following terms:
|
|
24
|
+
|
|
25
|
+
Attribution - You must give appropriate credit, provide a link to the
|
|
26
|
+
license, and indicate if changes were made. You may do so in
|
|
27
|
+
any reasonable manner, but not in any way that suggests the
|
|
28
|
+
licensor endorses you or your use.
|
|
29
|
+
|
|
30
|
+
No additional restrictions - You may not apply legal terms or technological
|
|
31
|
+
measures that legally restrict others from doing anything the
|
|
32
|
+
license permits.
|
|
33
|
+
|
|
34
|
+
Suggested attribution:
|
|
35
|
+
|
|
36
|
+
"StyleGallery" by IYEN, https://github.com/changeroa/StyleGallery,
|
|
37
|
+
licensed under CC BY 4.0.
|
|
38
|
+
|
|
39
|
+
The summary above is not a substitute for the license. The full legal code is
|
|
40
|
+
the binding text:
|
|
41
|
+
|
|
42
|
+
https://creativecommons.org/licenses/by/4.0/legalcode
|
package/NOTICE
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
StyleGallery
|
|
2
|
+
Copyright (c) 2026 IYEN
|
|
3
|
+
|
|
4
|
+
Licensing of this repository is split by kind of content:
|
|
5
|
+
|
|
6
|
+
- Source code: MIT License, see LICENSE.
|
|
7
|
+
- Documentation: Creative Commons Attribution 4.0 International, see
|
|
8
|
+
LICENSE-DOCS.
|
|
9
|
+
|
|
10
|
+
Third-party material
|
|
11
|
+
|
|
12
|
+
Some documentation leaves are independent method rewrites adapted from
|
|
13
|
+
external sources. Those sources keep their own rights; the licenses above
|
|
14
|
+
cover only the StyleGallery-authored expression. The repository does not
|
|
15
|
+
retain upstream prose, tables, code samples, distinctive examples, or
|
|
16
|
+
distinctive sequence from those sources, and it does not claim any license
|
|
17
|
+
over them.
|
|
18
|
+
|
|
19
|
+
Where a leaf was adapted from an external source, that leaf's own page
|
|
20
|
+
metadata records `source_repository`, the exact `source_path`, and the full
|
|
21
|
+
`source_revision`. Leaves authored locally carry `provenance_kind: local` and
|
|
22
|
+
no upstream fields. The governing rules are in DOMAINS.md under "External
|
|
23
|
+
Adaptation Contract".
|
|
24
|
+
|
|
25
|
+
The initial five domain leaves were inspired by emilkowalski/skills
|
|
26
|
+
(https://github.com/emilkowalski/skills) at snapshot
|
|
27
|
+
220e8607c90b17337d210125777b7b695f26c221, which is published under the MIT
|
|
28
|
+
License. If recognizable upstream expression is ever added, the full upstream
|
|
29
|
+
MIT notice is preserved alongside it and the copied material is recorded
|
|
30
|
+
separately before merge.
|
|
31
|
+
|
|
32
|
+
Observation records
|
|
33
|
+
|
|
34
|
+
Documents that describe observed behavior of third-party websites or
|
|
35
|
+
products are unofficial observation records. They are not affiliated with,
|
|
36
|
+
endorsed by, or derived from the code, assets, or copy of the sites they
|
|
37
|
+
describe, and product or company names in them are used only to identify the
|
|
38
|
+
subject of observation.
|
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@ description: Governed gallery of portable interface knowledge organized by domai
|
|
|
7
7
|
# StyleGallery
|
|
8
8
|
|
|
9
9
|
<p align="center">
|
|
10
|
-
<img
|
|
10
|
+
<img width="1774" height="887" alt="ChatGPT Image 2026년 9월 17일 오후 04_28_00" src="https://github.com/user-attachments/assets/a5ce35c0-546a-4e19-9d79-751a51c5e103" />
|
|
11
11
|
</p>
|
|
12
12
|
|
|
13
13
|
StyleGallery is a governed gallery of portable interface knowledge. It separates reusable spatial patterns, product-layer motion guidance, design-engineering practice, platform-specific references, and comparative design terminology into explicit domains with different evidence and ownership boundaries.
|
|
@@ -18,7 +18,7 @@ The existing Layout corpus remains a gallery of minimal, portable CSS layout pat
|
|
|
18
18
|
|
|
19
19
|
[Consumer Reference](consumer-reference/index.md) is shared non-domain infrastructure for optional consumer-owned reference handoffs. It carries schema, routing, provenance, and evidence metadata without owning profiles, visual values, components, or a seventh domain.
|
|
20
20
|
|
|
21
|
-
[Agent-Native StyleGallery](consumer-reference/agent-native/README.md)
|
|
21
|
+
[Agent-Native StyleGallery](consumer-reference/agent-native/README.md) documents the frozen v1 claim/evidence/governance interface. The `sg` CLI and main MCP server also expose [website compilation](scripts/compiler/README.md) through a separately installed compiler; isolated material v2 indexes admitted Markdown through `sg-material` and its read-only MCP. Lifecycle records own extension and archive dispositions. These interfaces do not create a seventh domain, replace the Markdown corpus, permit mutation of governed knowledge, or feed visual defaults back into Layout.
|
|
22
22
|
|
|
23
23
|
## Quick Start
|
|
24
24
|
|
|
@@ -46,7 +46,20 @@ sg context sg:profile/editorial-reference-profile --format json
|
|
|
46
46
|
sg ops --format json
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
Every command writes
|
|
49
|
+
Every command writes JSON to stdout. Knowledge results retain their deterministic v1 payloads; `discover` and `ops` also report the local compiler installation. Invalid input returns an error object and a nonzero exit status. See [Agent-Native StyleGallery](consumer-reference/agent-native/README.md) for the frozen knowledge contract, StableRef and VersionID model, MCP resources, and trust boundaries.
|
|
50
|
+
|
|
51
|
+
Compile a website directly through SG after [installing the compiler](scripts/compiler/README.md#setup):
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
export SG_COMPILER_ROOT=/absolute/path/to/site-compiler
|
|
55
|
+
sg compile --url https://example.com --out ./captures/example
|
|
56
|
+
sg timeline --url https://example.com --out ./captures/example --step 500
|
|
57
|
+
sg workflow
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
`compile`, `timeline`, `transcribe`, `sale`, `gate`, and `build` are direct SG commands and MCP tool names. See [SG Website Compilation](scripts/compiler/README.md) for all commands, configuration, output ownership, and verification.
|
|
61
|
+
|
|
62
|
+
Start with `sg workflow` to select the stages for reconstruction, adaptation, or sale-package production. For a faithful clone, use available original media and fill document gaps by inspecting the source. The automatic `build` command is a sale-edition preview with restricted source access; it is not the general clone builder.
|
|
50
63
|
|
|
51
64
|
Material v2 searches the admitted Markdown corpus and returns JSON without an additional format flag:
|
|
52
65
|
|
|
@@ -62,7 +75,11 @@ For a coding agent with repository filesystem access, local guided traversal is
|
|
|
62
75
|
|
|
63
76
|
The [StyleGallery homepage example](examples/stylegallery-homepage/README.md) was planned from a clean install of the published npm package. It demonstrates the Homepage recipe, selected layout patterns, agent-native CLI access, responsive behavior, and Chrome CDP verification in a standalone product-layer implementation.
|
|
64
77
|
|
|
65
|
-
|
|
78
|
+
The [Toss-inspired homepage clone](examples/toss-homepage-clone/README.md) applies the same workflow to an observed external homepage: it maps the source into section jobs, composes existing Layout patterns, keeps brand styling in the example layer, and records desktop, mobile, keyboard, overflow, and reduced-motion checks.
|
|
79
|
+
|
|
80
|
+
The [Scroll Story Lab](examples/scroll-story/README.md) adds runnable scroll-controlled product chapters, an image sequence with bounded decoding, native CSS scrubbing, and a static reading path. Start from [Motion’s scroll-driven story](motion/interaction-recipes.md#scroll-driven-story) for ownership and failure cases. The [Scene Navigation example](examples/scene-navigation/README.md) keeps the entire page fixed while wheel, keys, chapter links, and art-surface swipes select scenes; its [separate contract](motion/interaction-recipes.md#full-viewport-scene-navigation) covers input ownership, history, focus, and reading escape.
|
|
81
|
+
|
|
82
|
+
### MCP server
|
|
66
83
|
|
|
67
84
|
Launch the packaged stdio server with:
|
|
68
85
|
|
|
@@ -83,7 +100,7 @@ Example MCP client configuration:
|
|
|
83
100
|
}
|
|
84
101
|
```
|
|
85
102
|
|
|
86
|
-
The MCP
|
|
103
|
+
The main MCP server exposes governed read operations and compiler execution tools. Configure `SG_COMPILER_ROOT` in its environment to use the compiler. Execution tools declare file and network effects; the knowledge registry remains a read-only API. The frozen read-only server remains available as `npm run sg:mcp:v1`.
|
|
87
104
|
|
|
88
105
|
The separate Material v2 MCP server is available as `stylegallery-material-mcp`.
|
|
89
106
|
|
|
@@ -106,6 +123,8 @@ sg discover --format json
|
|
|
106
123
|
|
|
107
124
|
CLI와 MCP의 상세 사용법은 [Agent-Native StyleGallery 가이드](consumer-reference/agent-native/README.md)를 참고하세요. 사람이 문서를 탐색하려면 아래의 도메인 표에서 목적에 맞는 진입점을 선택하면 됩니다.
|
|
108
125
|
|
|
126
|
+
For UI state ownership, asynchronous races, drafts, URL/history, and persistence, start with [State Management](design-engineering/state-management/index.md) in Design Engineering.
|
|
127
|
+
|
|
109
128
|
## Domains
|
|
110
129
|
|
|
111
130
|
| Domain | Owns | Does not own |
|
|
@@ -119,6 +138,20 @@ CLI와 MCP의 상세 사용법은 [Agent-Native StyleGallery 가이드](consumer
|
|
|
119
138
|
|
|
120
139
|
The canonical domain manifest and provenance policy are in [StyleGallery Domains](DOMAINS.md).
|
|
121
140
|
|
|
141
|
+
## Practical Domain Workflows
|
|
142
|
+
|
|
143
|
+
| Task | Start | Apply and verify |
|
|
144
|
+
| --- | --- | --- |
|
|
145
|
+
| Design a transition | [Motion Decision Tree](motion/decision-tree.md) | [Brief](motion/motion-brief.md), [interaction recipes](motion/interaction-recipes.md), and [review](motion/review-workflow.md) |
|
|
146
|
+
| Build a product interaction | [Design Engineering Decision Tree](design-engineering/decision-tree.md) | [Component contract](design-engineering/component-contract.md) and [worked examples](design-engineering/worked-examples.md) |
|
|
147
|
+
| Compose a game screen | [Game UI Decision Tree](game-ui/decision-tree.md) | [Screen recipes](game-ui/screen-recipes.md) and [verification workflow](game-ui/verification-workflow.md) |
|
|
148
|
+
| Adapt a platform convention | [Platform Adaptation Workflow](platform-guides/adaptation-workflow.md) | [Apple](platform-guides/apple-interaction.md), [Android](platform-guides/android-interaction.md), [Windows](platform-guides/windows-interaction.md), and [compatibility matrix](platform-guides/compatibility-matrix.md) |
|
|
149
|
+
| Resolve a terminology conflict | [Design Term Comparison Workflow](design-terminology/comparison-workflow.md) | [Directly sourced term cases](design-terminology/conflict-cases.md) and [relation rules](design-terminology/relation-types.md) |
|
|
150
|
+
|
|
151
|
+
Layout 외 도메인도 선택 절차, 작성 양식, 적용 사례, 검증 경로를 제공합니다. 예제의 기대 결과는 실제 실행 증거와 구분하며, 공식 출처를 확인한 날짜와 적용 범위는 각 문서에 기록합니다. 문서 확충만으로 `experimental` 상태가 자동 승격되지는 않습니다.
|
|
152
|
+
|
|
153
|
+
[Interaction Lab](examples/domain-interactions/README.md)은 저장·검색·중첩 팝업·보상·입력 사례를 실행할 수 있는 브라우저 예제입니다. [검증 기록](examples/domain-interactions/verification.md)은 실제 Mac 브라우저에서 관찰한 결과와 모바일·네이티브 엔진 미검증 범위를 구분합니다.
|
|
154
|
+
|
|
122
155
|
## Repository Entry Roles
|
|
123
156
|
|
|
124
157
|
Use each root hub for one primary job.
|
|
@@ -166,7 +199,7 @@ Each common task has one primary route. Use secondary links only after the prima
|
|
|
166
199
|
| `check whether a layout or design claim is admissible` | [Quality Gates](quality/index.md) | It routes claims to gates and evidence boundaries. |
|
|
167
200
|
| `prove repository checks and evidence coverage` | [Executable Evidence Coverage](quality/evidence/executable-evidence.md) | It maps validators, fixtures, CI commands, and their boundaries. |
|
|
168
201
|
| `declare consumer reference applicability` | [Consumer Reference](consumer-reference/index.md) | It provides the required handoff field without moving consumer values into Layout. |
|
|
169
|
-
| `use StyleGallery from an agent or automation` | [Agent-Native StyleGallery](consumer-reference/agent-native/README.md) | It routes frozen v1 trust queries, material v2 discovery/search/get/context,
|
|
202
|
+
| `use StyleGallery from an agent or automation` | [Agent-Native StyleGallery](consumer-reference/agent-native/README.md) | It routes frozen v1 trust queries, material v2 discovery/search/get/context, extensions, lifecycle dispositions, and archive boundaries. Use [SG Website Compilation](scripts/compiler/README.md) for compiler commands in the main CLI and MCP. |
|
|
170
203
|
| `prove an existing consumer migration` | [Consumer Migration Readiness](design-engineering/consumer-migration-readiness.md) | It requires thirteen explicit behavior classifications, runtime proof, adoption mappings, and source-bound page evidence when applicable. |
|
|
171
204
|
| `change generated patterns, catalog, or governance policy` | [Governance, Lifecycle, And Docs-As-Code](GOVERNANCE.md) | It identifies source files, generated artifacts, validators, lifecycle state, and review ownership. |
|
|
172
205
|
| `run findability QA` | [Tree-Test Findability QA](quality/index.md#tree-test-findability-qa) | It tests whether task routes are discoverable, not just linked. |
|
|
@@ -218,3 +251,7 @@ Every pattern documents its primary problem, structure, constraints, scroll owne
|
|
|
218
251
|
## Verification Matrix
|
|
219
252
|
|
|
220
253
|
Pattern verification covers the relevant viewport, container, content, direction, writing-mode, interaction, overflow, focus, and sticky/scroll cases. See the [detailed verification matrix](layout/index.md#verification-matrix).
|
|
254
|
+
|
|
255
|
+
## License
|
|
256
|
+
|
|
257
|
+
Source code is licensed under the MIT License ([LICENSE](LICENSE)). Documentation is licensed under Creative Commons Attribution 4.0 International ([LICENSE-DOCS](LICENSE-DOCS)). Material adapted from external sources keeps its original rights; see [NOTICE](NOTICE) and the [External Adaptation Contract](DOMAINS.md#external-adaptation-contract).
|
|
@@ -6,7 +6,7 @@ description: Machine-facing identity, query, execution, protocol-projection, and
|
|
|
6
6
|
|
|
7
7
|
# Agent-Native StyleGallery
|
|
8
8
|
|
|
9
|
-
Primary role:
|
|
9
|
+
Primary role: frozen v1 knowledge interface guide. For the current `sg` CLI and main MCP server, including compiler execution, use [SG Website Compilation](../../scripts/compiler/README.md).
|
|
10
10
|
|
|
11
11
|
Agent-Native StyleGallery lets a person, script, or agent inspect the governed StyleGallery knowledge graph without learning repository paths first. The Markdown corpus remains the human-readable source material; the agent-native layer gives its governed fixture records stable identities, closed schemas, deterministic operations, and protocol-specific projections.
|
|
12
12
|
|
|
@@ -31,11 +31,11 @@ The canonical fixture and operation inventory is [registry.json](registry.json).
|
|
|
31
31
|
Run the CLI from the repository root:
|
|
32
32
|
|
|
33
33
|
```sh
|
|
34
|
-
npm run sg -- discover --format json
|
|
35
|
-
npm run sg -- resolve sg:profile/editorial-reference-profile --format json
|
|
36
|
-
npm run sg -- claims sg:profile/editorial-reference-profile --format json
|
|
37
|
-
npm run sg -- context sg:profile/editorial-reference-profile --format json
|
|
38
|
-
npm run sg -- ops --format json
|
|
34
|
+
npm run sg:v1 -- discover --format json
|
|
35
|
+
npm run sg:v1 -- resolve sg:profile/editorial-reference-profile --format json
|
|
36
|
+
npm run sg:v1 -- claims sg:profile/editorial-reference-profile --format json
|
|
37
|
+
npm run sg:v1 -- context sg:profile/editorial-reference-profile --format json
|
|
38
|
+
npm run sg:v1 -- ops --format json
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
The executable can also be invoked directly:
|
|
@@ -72,7 +72,7 @@ stylegallery-material search --query "design terminology source kinds" --paths-o
|
|
|
72
72
|
Start the stdio MCP server with:
|
|
73
73
|
|
|
74
74
|
```sh
|
|
75
|
-
npm run sg:mcp
|
|
75
|
+
npm run sg:mcp:v1
|
|
76
76
|
```
|
|
77
77
|
|
|
78
78
|
An MCP client can launch it directly:
|