@thjodann/wk 1.0.2 → 1.0.4

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/docs/setup.md CHANGED
@@ -139,12 +139,13 @@ wk site --audience user
139
139
 
140
140
  Before running `wk theme init`, the agent should inspect the host repo's actual
141
141
  visual sources: app/global CSS, design tokens, theme files, landing page styles,
142
- and app shell/layout styles. `wk theme preview` and `wk theme init` also inspect
143
- those files automatically when they are present, then fall back to README and
144
- package metadata for naming and copy. In styled web apps, this lets
142
+ app shell/layout styles, brand image assets, favicon files, and repo-local font
143
+ files. `wk theme preview` and `wk theme init` also inspect those files
144
+ automatically when they are present, then fall back to README and package
145
+ metadata for naming and copy. In styled web apps, this lets
145
146
  `.wikiwiki/site-theme.json` start with the host product's likely color mode,
146
147
  accent spectrum, radius, font family, gradients, glass/gloss, shadows, badges,
147
- and tag colors.
148
+ tag colors, product mark, and typography.
148
149
 
149
150
  After the theme is in place, seed a small set of high-signal records before
150
151
  publishing the first site: product promise, privacy/data boundary, architecture
@@ -155,6 +156,7 @@ event. Then verify the generated site like a real local artifact:
155
156
  - check Auto, Light, and Dark controls
156
157
  - check local links and source-file links
157
158
  - check search
159
+ - check the tab favicon, sidebar mark, home logo/wordmark, and custom fonts
158
160
  - check contrast for body text, muted text, accents, badges, and tags
159
161
  - keep `wiki-site/` generated; edit `.wikiwiki/site-theme.json` and records
160
162
 
@@ -206,6 +208,11 @@ while overwriting the bundled `wk` skill files:
206
208
  wk install-agent codex --yes --force
207
209
  ```
208
210
 
211
+ Once installed, a bare `wk`, `/wk`, `$wk`, or linked `$wk` request means "show
212
+ me the generated wiki site." The skill should return one concise link to an
213
+ existing `wiki-site/index.html`; it should not run status/spin, generate files,
214
+ start a server, or explain the skill for that bare invocation.
215
+
209
216
  To install manually on macOS or Linux:
210
217
 
211
218
  ```sh
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thjodann/wk",
3
- "version": "1.0.2",
3
+ "version": "1.0.4",
4
4
  "description": "Wikiwiki is an agent-native living documentation system for code repos.",
5
5
  "license": "MIT",
6
6
  "type": "commonjs",
@@ -11,6 +11,18 @@ Use `wk` as the repo-local memory loop for agents. It keeps durable project know
11
11
 
12
12
  Prefer JSON output, preserve user work, and treat structured records as the source of truth. Records are the ledger; articles are the wiki. Lean on deterministic CLI commands for status, validation, rendering, site generation, and search; use model judgment for deciding what knowledge matters, updating public article prose, attaching source records, and polishing drafts. The generated site should feel like the user's project wiki; keep Wikiwiki itself quiet unless credit or setup context is needed.
13
13
 
14
+ ## Bare Invocation Default
15
+
16
+ When the user invokes only `wk`, `/wk`, `$wk`, or `[$wk](...)` with no
17
+ additional request, treat it as "show me the generated wiki site." Do not run
18
+ the normal status/spin workflow, do not modify files, and do not explain the
19
+ skill. Find the current repo root or workspace, prefer an existing
20
+ `wiki-site/index.html`, and return a single concise Markdown link using the
21
+ absolute local file path. If the site is already known to be served through a
22
+ local URL, a direct URL to that same generated site is also acceptable. Do not
23
+ start a server just for a bare invocation. If no generated site exists, say so
24
+ briefly and suggest `wk site --audience all` or the repo's `wiki:site` script.
25
+
14
26
  ## Start Of Work
15
27
 
16
28
  1. Find the repo root before running `wk`.
@@ -128,8 +140,9 @@ wiki. Make the first generated site feel native to the host project:
128
140
  1. Run `wk setup --profile mixed --audience all --agent codex` in Codex-compatible IDEs so repo setup also installs the companion `/wk` skill.
129
141
  2. Inspect README/docs/package metadata for product identity and durable facts.
130
142
  3. Inspect actual visual sources before writing a theme: app/global CSS, design
131
- tokens, theme files, landing page styles, app shell/layout styles, and any
132
- existing brand palette files.
143
+ tokens, theme files, landing page styles, app shell/layout styles, brand
144
+ image assets, favicon files, repo-local font files, and any existing brand
145
+ palette files.
133
146
  4. Run `wk theme preview --json`. If the preview looks right, run
134
147
  `wk theme init`; otherwise pass explicit `--project-name`, `--description`,
135
148
  or `--mood`, then preview again.
@@ -137,8 +150,9 @@ wiki. Make the first generated site feel native to the host project:
137
150
  architecture, distribution/support, important symbols, and a devlog event.
138
151
  6. Run `wk validate`, `wk render`, and `wk site --audience all`.
139
152
  7. Verify the generated site locally: Auto/Light/Dark controls, default theme,
140
- search, local links/source-file links, and contrast for body text, muted
141
- text, accents, badges, and tags.
153
+ favicon, sidebar mark, home logo/wordmark, custom fonts, search, local
154
+ links/source-file links, and contrast for body text, muted text, accents,
155
+ badges, and tags.
142
156
 
143
157
  Do not edit generated CSS in `wiki-site/`. The source of truth is
144
158
  `.wikiwiki/site-theme.json` plus structured records.
@@ -248,4 +262,4 @@ steps and use the normal Wikiwiki flow.
248
262
 
249
263
  ## Site Theme Guidance
250
264
 
251
- When asked to make the human wiki match a project, edit `.wikiwiki/site-theme.json` rather than generated CSS. Prefer `wk theme preview --json` and `wk theme init` first because they inspect CSS/design sources when present. If you hand-edit, use the host project's real visual language literally: default color mode, paired light/dark palettes, accent spectrum, neutral surfaces, sidebar/hero/card gradients, brand gradient, badge/tag colors, focus ring, gloss, shadows, border radius, code background, and font family. Then run `wk validate`, `wk render`, and `wk site`.
265
+ When asked to make the human wiki match a project, edit `.wikiwiki/site-theme.json` rather than generated CSS. Prefer `wk theme preview --json` and `wk theme init` first because they inspect CSS/design sources, brand image assets, favicon files, and repo-local font files when present. If you hand-edit, use the host project's real visual language literally: default color mode, paired light/dark palettes, accent spectrum, neutral surfaces, sidebar/hero/card gradients, brand gradient, logo/wordmark/favicon paths, badge/tag colors, focus ring, gloss, shadows, border radius, code background, font files, and font family. Then run `wk validate`, `wk render`, and `wk site`.