@theglitchking/hit-em-with-the-docs 2.7.0 → 2.7.1

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.
@@ -6,13 +6,13 @@
6
6
  },
7
7
  "metadata": {
8
8
  "description": "Official marketplace for hit-em-with-the-docs - Self-managing documentation system",
9
- "version": "2.7.0"
9
+ "version": "2.7.1"
10
10
  },
11
11
  "plugins": [
12
12
  {
13
13
  "name": "hit-em-with-the-docs",
14
14
  "description": "Self-managing documentation system with hierarchical structure, intelligent automation, pattern discovery, and agent orchestration",
15
- "version": "2.7.0",
15
+ "version": "2.7.1",
16
16
  "author": {
17
17
  "name": "TheGlitchKing"
18
18
  },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "hit-em-with-the-docs",
3
3
  "description": "Self-managing documentation system with hierarchical structure, intelligent automation, pattern discovery, and agent orchestration",
4
- "version": "2.7.0",
4
+ "version": "2.7.1",
5
5
  "author": {
6
6
  "name": "TheGlitchKing",
7
7
  "email": "theglitchking@users.noreply.github.com"
package/README.md CHANGED
@@ -874,6 +874,26 @@ src/
874
874
  └── logger.ts # Logging and output formatting
875
875
  ```
876
876
 
877
+ ### Indexing: what counts as a document
878
+
879
+ `INDEX.md` and `REGISTRY.md` are **generated** — `index`, `maintain`, and
880
+ `integrate` rebuild them from disk, so a row you add by hand is overwritten on
881
+ the next run.
882
+
883
+ Domain folders are walked **recursively**, so a document at any depth inside a
884
+ domain is indexed (`standards/backend/foo.md` appears in `standards/INDEX.md` as
885
+ `backend/foo.md`). Never indexed: the generated `INDEX.md`/`REGISTRY.md`
886
+ themselves; anything under `archive/`, `drafts/`, `reports/`, `_templates/`,
887
+ `node_modules/`, or a nested `.documentation/`; and the vault's `facts/`,
888
+ `incidents/`, and `symptoms/` subtrees, which have their own generators.
889
+
890
+ Recursive indexing landed in **2.7.1**. Before that the walk was flat and every
891
+ document in a subfolder was invisible to the whole system — so the first
892
+ `index`/`maintain` run after upgrading will add a row for each one.
893
+
894
+ **Full contract, and the troubleshooting ladder for "my doc isn't in the index":
895
+ [docs/indexing.md](docs/indexing.md).**
896
+
877
897
  ### File Structure
878
898
 
879
899
  When you run `hewtd init`, it creates this structure:
@@ -887,7 +907,9 @@ When you run `hewtd init`, it creates this structure:
887
907
  ├── security/ # Security documentation (priority: 9)
888
908
  │ ├── INDEX.md # Security domain table of contents
889
909
  │ ├── REGISTRY.md # Quick reference for security docs
890
- └── *.md # Individual security documents
910
+ ├── *.md # Individual security documents
911
+ │ └── auth/ # Subfolders are indexed too (2.7.1+)
912
+ │ └── *.md # → listed as auth/<name>.md
891
913
 
892
914
  ├── api/ # API documentation (priority: 8)
893
915
  │ ├── INDEX.md
@@ -9,6 +9,12 @@ export interface RegenerateOptions {
9
9
  */
10
10
  domains?: Domain[];
11
11
  silent?: boolean;
12
+ /**
13
+ * Compute everything, write nothing. `filesWritten` then lists the files
14
+ * that WOULD be written. Exists so users can preview the (large, one-time)
15
+ * diff the 2.7.1 recursive walk produces before committing to it.
16
+ */
17
+ dryRun?: boolean;
12
18
  }
13
19
  export interface RegenerateResult {
14
20
  /** Per-domain document counts — all domains, regardless of the filter. */
@@ -19,9 +25,14 @@ export interface RegenerateResult {
19
25
  totalDocuments: number;
20
26
  }
21
27
  /**
22
- * List the document files in a domain directory, excluding the generated
23
- * INDEX.md / REGISTRY.md. Returns sorted file names (not paths). Empty when
24
- * the domain directory does not exist.
28
+ * List the document files in a domain directory, walking subfolders. Returns
29
+ * sorted, domain-relative POSIX paths (`backend/entity-schema-contract.md`).
30
+ * Empty when the domain directory does not exist.
31
+ *
32
+ * This is the shared spine for three consumers — the index generator, the
33
+ * `index-drift` audit rule, and the `domain remove` orphan count — so what it
34
+ * excludes, the whole system excludes: the generated INDEX/REGISTRY at any
35
+ * depth, `EXCLUDED_DIRS`, and the vault's generator-owned subtrees (issue #12).
25
36
  */
26
37
  export declare function listDomainDocFiles(docsPath: string, domain: string): Promise<string[]>;
27
38
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"regenerate.d.ts","sourceRoot":"","sources":["file:///home/tmarlette/workspace/the-glitch-kingdom/hit-em-with-the-docs/src/generators/regenerate.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAmB3D,MAAM,WAAW,iBAAiB;IAChC,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,0EAA0E;IAC1E,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,8DAA8D;IAC9D,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,EAAE,CAAC,CASnB;AAkED;;;;;;;;;GASG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,gBAAgB,CAAC,CAkE3B"}
1
+ {"version":3,"file":"regenerate.d.ts","sourceRoot":"","sources":["file:///home/tmarlette/workspace/the-glitch-kingdom/hit-em-with-the-docs/src/generators/regenerate.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAiE3D,MAAM,WAAW,iBAAiB;IAChC,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,0EAA0E;IAC1E,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,8DAA8D;IAC9D,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CACtC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,EAAE,CAAC,CAmBnB;AAwFD;;;;;;;;;GASG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,gBAAgB,CAAC,CAuE3B"}