[POC] feat: scaffold Tariffs KIT at Sandbox maturity#1505
[POC] feat: scaffold Tariffs KIT at Sandbox maturity#1505
Conversation
Co-authored-by: matbmoser <71728767+matbmoser@users.noreply.github.com>
|
@copilot review this PR. |
…dence) Co-authored-by: matbmoser <71728767+matbmoser@users.noreply.github.com>
👋 I'm the KIT Master Builder — here's my full review of this PR. ✅ What I Like
|
| Check | Status |
|---|---|
| Frontmatter complete | ✅ |
| CC-BY-4.0 header | ✅ |
| NOTICE footer | ✅ |
| Kit3DLogo rendered | ✅ |
| Changelog with version entry | ✅ |
| Diagrams as code (TRG 1.04) | ✅ |
SVG logo + .license sidecar |
✅ |
| Master data entry (kitsData.js) | ✅ |
| Sidebar entry (alphabetical) | ✅ |
| REUSE.toml (fixed) | ✅ |
| ID unique across all arrays | ✅ |
| Sandbox route prefix | ✅ |
| markdownlint 0 errors | ✅ |
Overall: This is a solid Sandbox KIT scaffold. The one formatting issue I found (REUSE.toml) has been fixed in be7a8b9. Ready for the next iteration when the domain experts provide real content! 🏗️
There was a problem hiding this comment.
Pull request overview
This PR scaffolds a new Tariffs KIT at Sandbox maturity, adding initial KIT documentation, logo assets, and registering the KIT in the site’s master data and navigation.
Changes:
- Added Tariffs KIT documentation pages (changelog, adoption view, development view) and a resources REUSE file.
- Added a new Tariffs KIT logo SVG plus
.licensesidecar. - Registered the KIT in
data/kitsData.js,sidebarsDocsKits.js, and regenerated nav items.
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
utils/generated/kitNavItems.js |
Regenerated nav items to include the new Tariffs KIT entry. |
static/img/kits/tariffs/tariffs-kit-raw-logo.svg |
Adds the Tariffs KIT SVG logo asset. |
static/img/kits/tariffs/tariffs-kit-raw-logo.svg.license |
Adds CC-BY-4.0 license sidecar metadata for the logo. |
sidebarsDocsKits.js |
Adds Tariffs KIT to the docs sidebar navigation. |
docs-kits/kits/tariffs-kit/resources/REUSE.toml |
Introduces REUSE annotations for Tariffs KIT resources. |
docs-kits/kits/tariffs-kit/development-view/development-view.md |
Adds the initial Development View content and diagrams/models. |
docs-kits/kits/tariffs-kit/changelog.md |
Adds initial changelog for version 0.1.0. |
docs-kits/kits/tariffs-kit/adoption-view/adoption-view.md |
Adds the initial Adoption View content and diagrams/tables. |
data/kitsData.js |
Imports the new logo and registers the Tariffs KIT master data entry (Sandbox). |
Comments suppressed due to low confidence (2)
docs-kits/kits/tariffs-kit/resources/REUSE.toml:10
pathis defined as a string ("**") and the annotation is missingprecedence = "closest". Elsewhere in the repo, REUSE.toml uses an array forpath(e.g.,["*.png", ...]) and sets precedence. Align this file to the same structure so REUSE tooling interprets the annotation consistently.
SPDX-License-Identifier = "CC-BY-4.0"
data/kitsData.js:794
- There is inconsistent indentation after the new
tariffsKIT entry (},followed by an extra-indented{). Please normalize the indentation to match the surrounding array entries to keepkitsData.jsreadable and reduce diff noise.
},
{
id: 'osim',
name: 'ONLINE SIMULATION KIT',
| id: 'tariffs', | ||
| name: 'TARIFFS KIT', | ||
| logo: TariffsKitLogo, | ||
| logoLicencse: { |
| 'kits/tariffs-kit/changelog', | ||
| 'kits/tariffs-kit/adoption-view/adoption-view', | ||
| 'kits/tariffs-kit/development-view/development-view' |
Caution
Don't merge this, is only a proof of concept!
👋 Hi! I'm the KIT Master Builder — your Eclipse Tractus-X KIT architect.
Adds a first example "Tariffs KIT" — a Catena-X KIT for standardized exchange of tariff classifications, HS/CN codes, and duty-relevant product data across global supply chains.
New files —
docs-kits/kits/tariffs-kit/changelog.md— initial0.1.0entryadoption-view/adoption-view.md— vision/mission, business context (Mermaid flow), use cases (HS code sharing, preferential origin, sourcing analysis), personas, standards tabledevelopment-view/development-view.md— Mermaid sequence diagram (request/response flow), JSON semantic model stubs for tariff request & response, protocols tableresources/REUSE.toml— CC-BY-4.0 annotation for resources dirLogo —
static/img/kits/tariffs/tariffs-kit-raw-logo.svg— white monochrome scale/balance icontariffs-kit-raw-logo.svg.license— CC-BY-4.0 sidecarRegistration
data/kitsData.js— importsTariffsKitLogo; adds master data entry underuseCases(Supply Chain domain, Sandbox/draft,latestVersion: '0.1.0')sidebarsDocsKits.js— inserts'Tariffs KIT'category alphabetically before'Traceability KIT'All
.mdfiles carry CC-BY-4.0 headers and## NOTICEfooters (TRG 7.07); diagrams are Mermaid (TRG 1.04);Kit3DLogorendered on every page.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.