Spec points to a [platforms.<id>] reference it does not contain; CLI error and doc comments still say top-level `manifest`
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- markdown, rust
- Domain
- cli, documentation
Research direction
Start with packages/design-data-spec/spec/dataset-layout.md and spec/manifest.md, then review the error in sdk/cli/src/main.rs and comments in sdk/core/src/manifest.rs. Update the configuration reference and link, and align the error and comments with the supported platform options; done when all four locations describe [platforms.<id>], default_platform, --platform, and the legacy manifest key accurately.
Written by the indexing model from the issue text.
Description
Summary
The spec points readers to a .design-data.toml reference for [platforms.<id>] profiles that it does not contain, and the CLI error text and two doc comments still describe only the legacy top-level manifest key.
Spec
packages/design-data-spec/spec/manifest.md:91says several manifests are configured via named[platforms.<id>]profiles, "see the SDK's.design-data.tomlreference". There is no link, andspec/dataset-layout.md:48and:60describe only[source],[cache]and the top-levelmanifest.[platforms.<id>]anddefault_platformare documented only inplatforms/README.mdanddocs/site/src/articles/configuring-design-data-for-your-platform.md.
CLI and doc comments
With a [platforms.rune] entry and no default_platform, design-data validate-manifest (CLI 0.31.0) says:
design-data: error: no platform manifest configured (set the `.design-data.toml` top-level `manifest` key, or pass --manifest <FILE>)
It doesn't mention [platforms.<id>], --platform or default_platform.
sdk/cli/src/main.rs:2372-2373: the message above.sdk/core/src/manifest.rs:14and:277-278: module and function docs say "top-levelmanifestkey".
(The SourceConfig doc comments in sdk/core/src/data_source/mod.rs:109 and :132 already mention [platforms.<id>].)
Suggested fix
Document [platforms.<id>] and default_platform in dataset-layout.md and link it from manifest.md:91; reword the error and the two doc comments to name [platforms.<id>], --platform and the legacy manifest key.
- Dominant language
- Rust
- Stars
- 157
- Forks
- 37
- Avg merge
- 6h 30m
- Merged PRs (30d)
- 187
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from adobe/spectrum-design-data
-
spec-tooling
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
adobe/spectrum-design-data#1011 ·
Maintainers usually reply within 1 day
-
spec-tooling
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
adobe/spectrum-design-data#1012 ·
Maintainers usually reply within 1 day
-
spec-tooling
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
adobe/spectrum-design-data#1009 ·
Maintainers usually reply within 1 day
-
spec-tooling
Difficulty 2/5 Half a day Newbie friendliness 78/100
adobe/spectrum-design-data#1010 ·
Maintainers usually reply within 1 day
-
spec-tooling
Difficulty 1/5 Under an hour Newbie friendliness 88/100
adobe/spectrum-design-data#1007 ·
Maintainers usually reply within 1 day
All issues in adobe/spectrum-design-data
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
aws/aws-emulator#30 · 1 comment ·
-
tormach-plasma refusal text with no machine reads "no machine is not declared a plasma machine"Openarea:post bug effort:low P2 source:agent
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
Chat images never show without ImageMagick: ffprobe fallback uses an option string ffprobe 9 rejectsOpen
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
eliasstravik/herdr-projects#1011 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day