@imfusion/web-ui 0.6.1-dev.20.g3845eed7 → 0.6.1-dev.21.g9e345485
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/package.json
CHANGED
|
@@ -20,14 +20,15 @@ not already have.
|
|
|
20
20
|
|
|
21
21
|
## 2. Route the task
|
|
22
22
|
|
|
23
|
-
| Task | Open
|
|
24
|
-
| ----------------------------------------------------------------- |
|
|
25
|
-
| Look up a component, part, prop, default, or icon | `imf-web-ui-components`
|
|
26
|
-
| Choose components or shape a screen or flow | `imf-web-ui-ux`
|
|
27
|
-
| Write
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
23
|
+
| Task | Open |
|
|
24
|
+
| ----------------------------------------------------------------- | ------------------------------------------------------ |
|
|
25
|
+
| Look up a component, part, prop, default, or icon | `imf-web-ui-components` |
|
|
26
|
+
| Choose components or shape a screen or flow | `imf-web-ui-ux` |
|
|
27
|
+
| Write or update documentation | `/documentation-writer`, then `imf-web-ui-conventions` |
|
|
28
|
+
| Write a wrapper, custom UI, CSS, data layer, validation, or tests | `imf-web-ui-conventions` |
|
|
29
|
+
| Install the library or bootstrap project tooling | `imf-web-ui-setup` |
|
|
30
|
+
| Inspect an existing project without changing it | `imf-web-ui-audit` |
|
|
31
|
+
| Update the package, skills, or hooks | `imf-web-ui-update` |
|
|
31
32
|
|
|
32
33
|
A screen often needs both `imf-web-ui-ux` and `imf-web-ui-components`, in that order. Setup and audit are for project-wide
|
|
33
34
|
questions, not every one-file edit.
|
|
@@ -42,3 +42,8 @@ as patterns, and keep any exception explicit in the host project.
|
|
|
42
42
|
|
|
43
43
|
`imf-web-ui-setup` uses these topics to plan approved project changes. `imf-web-ui-audit` uses them to report the current
|
|
44
44
|
state without changing files.
|
|
45
|
+
|
|
46
|
+
## Documentation
|
|
47
|
+
|
|
48
|
+
Invoke `/documentation-writer` for new or updated documentation. Use the `docs-structure` topic for repository-specific
|
|
49
|
+
boundaries and conventions; it supplies context for the writer and does not replace the writer's workflow.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Documentation structure
|
|
2
2
|
|
|
3
|
-
Keep repository docs useful to a human who has just joined the project.
|
|
4
|
-
skill can check it.
|
|
3
|
+
Keep repository docs useful to a human who has just joined the project. Invoke `/documentation-writer` for new or updated
|
|
4
|
+
documentation. The setup skill can propose the shape; the audit skill can check it.
|
|
5
5
|
|
|
6
6
|
## The shape
|
|
7
7
|
|
|
@@ -20,7 +20,9 @@ working choices.
|
|
|
20
20
|
2. Enter the host's plan mode before inspecting or proposing changes.
|
|
21
21
|
3. Read the selected convention topics and inspect the repository with `Read`, `Glob`, and `Grep` only.
|
|
22
22
|
4. Put a complete proposal in the host plan, using [`templates/REPORT.md`](../imf-web-ui-conventions/templates/REPORT.md).
|
|
23
|
-
|
|
23
|
+
For new or updated documentation, invoke `/documentation-writer` before writing and use the `docs-structure` topic for
|
|
24
|
+
repository-specific boundaries. Name every file to create or change, include its intended content, and cite the repository
|
|
25
|
+
evidence behind the choice.
|
|
24
26
|
5. Wait for explicit approval. After approval, write only the listed files.
|
|
25
27
|
6. Run `imf-web-ui-audit full` as a follow-up and review its findings before calling setup complete.
|
|
26
28
|
|