Objective
Document the breaking Design Language Mode major releases as a generic,
reusable contributor workflow for any consuming repository.
Required documentation
- Installation and coordinated versioning of
@viscalyx/developer-mode-core and @viscalyx/developer-mode-react.
- Local-development-only framework integration and verification that inspector
JavaScript, CSS, metadata, registry pages, and related build wiring are absent
from compiled builds.
- How a consuming repository defines, validates, and governs its own vocabulary
of canonical English names, kinds, purposes, and discouraged synonyms.
- How sparse annotations and standard semantic control detection work, including
nested named-surface paths and all forbidden runtime or implementation data.
- How a consumer generates and checks in a readable vocabulary reference from
its registry without creating a second source of truth.
- The contributor workflow: activate the mode, hover to see the canonical
target, click to copy the full surface path, and use that reference in an AI
or human handoff.
- A migration guide from the obsolete markers, scanner heuristics, values,
contexts, priorities, downstream safelists, noops, aliases, and legacy tests.
- A complete generic example based on the Kravhantering integration pattern,
without making the documentation application-specific.
Scaffold, verification, and release details
- Document the
design-language init, design-language generate, and
design-language check lifecycle from
Add the Design Language Mode consumer scaffold and reference CLI.
- Use
lib/design-language/vocabulary.json and
docs/development/design-language-vocabulary.md as the default consumer
paths, explain safe initialization and explicit path overrides, and state
that generated Markdown must not be edited independently.
- Explain name-derived keys, the separate discouraged-synonym map, typed
key-only annotations, core-owned standard controls, and independent portal
surface paths.
- State that design-language metadata is not a general test or guide selector
API; consumers prefer semantic locators and use narrowly purpose-built hooks
only where semantics cannot identify a target.
- Document the mandatory desktop keyboard-and-hover boundary and the explicit
absence of touch and mobile-support obligations.
- Provide a production-exclusion recipe covering import-boundary tests,
compiled-artifact auditing, an explicit runtime absence check, and startup
after omitting development dependencies.
- Document the coordinated
1.0.0-rc.1 real-consumer gate followed by stable
1.0.0 publication from the same commit.
Link the documentation to all implementation issues and publish it with the
coordinated major releases.
Objective
Document the breaking Design Language Mode major releases as a generic,
reusable contributor workflow for any consuming repository.
Required documentation
@viscalyx/developer-mode-coreand@viscalyx/developer-mode-react.JavaScript, CSS, metadata, registry pages, and related build wiring are absent
from compiled builds.
of canonical English names, kinds, purposes, and discouraged synonyms.
nested named-surface paths and all forbidden runtime or implementation data.
its registry without creating a second source of truth.
target, click to copy the full surface path, and use that reference in an AI
or human handoff.
contexts, priorities, downstream safelists, noops, aliases, and legacy tests.
without making the documentation application-specific.
Scaffold, verification, and release details
design-language init,design-language generate, anddesign-language checklifecycle fromAdd the Design Language Mode consumer scaffold and reference CLI.
lib/design-language/vocabulary.jsonanddocs/development/design-language-vocabulary.mdas the default consumerpaths, explain safe initialization and explicit path overrides, and state
that generated Markdown must not be edited independently.
key-only annotations, core-owned standard controls, and independent portal
surface paths.
API; consumers prefer semantic locators and use narrowly purpose-built hooks
only where semantics cannot identify a target.
absence of touch and mobile-support obligations.
compiled-artifact auditing, an explicit runtime absence check, and startup
after omitting development dependencies.
1.0.0-rc.1real-consumer gate followed by stable1.0.0publication from the same commit.Link the documentation to all implementation issues and publish it with the
coordinated major releases.