document360-writer 0.4.54 → 0.4.56

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.
@@ -1,20 +1,25 @@
1
1
  import type { SlashCommandResult } from './index.js';
2
2
  import type { ReplContext } from '../repl.js';
3
3
  /** Bump when the guide content changes — lets a future check detect a stale committed guide. */
4
- export declare const DEV_HINTS_GUIDE_VERSION = 1;
4
+ export declare const DEV_HINTS_GUIDE_VERSION = 2;
5
5
  /**
6
- * The committed protocol guide the SOURCE repo's coding agent follows to write doc hints. It is
7
- * self-contained because that agent has none of d360-writer's context (no tools, no system prompt)
8
- * everything it needs to produce a valid hint is here. The /devhints command writes this to
9
- * `.d360-writer/DEV-HINTS-GUIDE.md`; the paste block (below) just points the source agent at it.
6
+ * The committed protocol guide the SOURCE repo's coding agent follows. Self-contained because that
7
+ * agent has none of d360-writer's context. Two parts: (1) a ONE-TIME architecture brief that onboards
8
+ * the docs agent the builder, who holds the full intent, hands over what code alone can't tell a
9
+ * writer; (2) ONGOING per-change doc hints. The /devhints command writes this to
10
+ * `.d360-writer/DEV-HINTS-GUIDE.md`; the paste block points the source agent at it.
10
11
  */
11
12
  export declare function devHintsGuide(): string;
12
- /** `/devhints` scaffold the hint channel: write the committed guide + emit a paste-ready block the
13
- user adds to their SOURCE repo's CLAUDE.md/AGENTS.md so its coding agent starts leaving hints. */
13
+ /** The human-owned creator-notes template (scaffolded once, never overwritten). The builder reads it
14
+ first as authoritative; the docs agent reads it as authoritative intent. */
15
+ export declare function creatorNotesTemplate(): string;
16
+ /** `/devhints` — scaffold the dev→docs hand-off: write the committed guide + the architecture inbox
17
+ (with a human creator-notes template) + the hints inbox, then emit a paste-ready block for the
18
+ SOURCE repo's CLAUDE.md/AGENTS.md so its coding agent onboards the docs agent and keeps it current. */
14
19
  export declare function devhintsCommand(_args: string[], ctx: ReplContext): Promise<SlashCommandResult>;
15
20
  /**
16
21
  * The paste-ready block for the user to add to their SOURCE repo's agent memory (CLAUDE.md/AGENTS.md).
17
- * A ONE-LINE pointer to the committed guide — not the protocol inline — so their memory stays lean and
18
- * we can improve the guide without anyone re-pasting. Mirrors renderTestidHandoff's bracketed shape.
22
+ * A pointer to the committed guide plus the ordered marching orders — not the protocol inline — so their
23
+ * memory stays lean and we can improve the guide without re-pasting. Mirrors renderTestidHandoff's shape.
19
24
  */
20
25
  export declare function renderDevHintsHandoff(): string[];
@@ -8,8 +8,9 @@ export declare function fetchProjects(cwd: string, profileName?: string): Promis
8
8
  }>;
9
9
  /** Match a project by exact name, name-prefix, or id-prefix (for `/project <name>`). */
10
10
  export declare function matchProject(projects: D360Project[], query: string): D360Project | undefined;
11
- /** Switching project invalidates any selected workspace — clear it so /workspace re-picks. */
12
- export declare function setProject(cwd: string, profileName: string, projectId: string): void;
11
+ /** Switching project invalidates any selected workspace — clear it so /workspace re-picks. Caches the
12
+ project NAME for display (banner, workspace picker) so we never show a bare GUID. */
13
+ export declare function setProject(cwd: string, profileName: string, projectId: string, projectName?: string): void;
13
14
  /** Non-interactive set-by-name (scriptable): `d360-writer project use <name>`. */
14
15
  export declare function runProjectUse(cwd: string, query: string, profileName?: string): Promise<number>;
15
16
  /** CLI / login path: list projects and prompt (interactive TTY). Persists the choice. */
@@ -3,6 +3,7 @@ import { type D360Workspace } from 'document360-engine';
3
3
  export declare function fetchWorkspaces(cwd: string, profileName?: string): Promise<{
4
4
  workspaces: D360Workspace[];
5
5
  projectId: string;
6
+ projectName?: string;
6
7
  profile: string;
7
8
  environment: string;
8
9
  current?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "document360-writer",
3
- "version": "0.4.54",
3
+ "version": "0.4.56",
4
4
  "description": "Standalone documentation agent CLI. Reads your code, writes your docs. Specialized for Document360 publishing.",
5
5
  "type": "module",
6
6
  "bin": {
@@ -34,7 +34,7 @@
34
34
  "@inquirer/prompts": "^8.4.3",
35
35
  "commander": "^14.0.3",
36
36
  "diff": "^8.0.4",
37
- "document360-engine": "^0.2.31",
37
+ "document360-engine": "^0.2.33",
38
38
  "ink": "^5.2.1",
39
39
  "picocolors": "^1.1.1",
40
40
  "react": "^18.3.1",