@connextar/house 0.15.1 → 0.16.0

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.
Files changed (49) hide show
  1. package/README.md +60 -2
  2. package/dist/changelog/changelog.d.ts +10 -1
  3. package/dist/changelog/changelog.d.ts.map +1 -1
  4. package/dist/changelog/changelog.js +11 -3
  5. package/dist/changelog/changelog.js.map +1 -1
  6. package/dist/guides/guide-article.d.ts +27 -0
  7. package/dist/guides/guide-article.d.ts.map +1 -0
  8. package/dist/guides/guide-article.js +19 -0
  9. package/dist/guides/guide-article.js.map +1 -0
  10. package/dist/guides/guide-toc.d.ts +22 -0
  11. package/dist/guides/guide-toc.d.ts.map +1 -0
  12. package/dist/guides/guide-toc.js +66 -0
  13. package/dist/guides/guide-toc.js.map +1 -0
  14. package/dist/guides/guides-landing.d.ts +14 -0
  15. package/dist/guides/guides-landing.d.ts.map +1 -0
  16. package/dist/guides/guides-landing.js +12 -0
  17. package/dist/guides/guides-landing.js.map +1 -0
  18. package/dist/guides/guides-search.d.ts +13 -0
  19. package/dist/guides/guides-search.d.ts.map +1 -0
  20. package/dist/guides/guides-search.js +68 -0
  21. package/dist/guides/guides-search.js.map +1 -0
  22. package/dist/guides/guides-shell.d.ts +15 -0
  23. package/dist/guides/guides-shell.d.ts.map +1 -0
  24. package/dist/guides/guides-shell.js +19 -0
  25. package/dist/guides/guides-shell.js.map +1 -0
  26. package/dist/guides/guides-sidebar.d.ts +10 -0
  27. package/dist/guides/guides-sidebar.d.ts.map +1 -0
  28. package/dist/guides/guides-sidebar.js +29 -0
  29. package/dist/guides/guides-sidebar.js.map +1 -0
  30. package/dist/guides/index.d.ts +8 -0
  31. package/dist/guides/index.d.ts.map +1 -0
  32. package/dist/guides/index.js +8 -0
  33. package/dist/guides/index.js.map +1 -0
  34. package/dist/guides/library.d.ts +85 -0
  35. package/dist/guides/library.d.ts.map +1 -0
  36. package/dist/guides/library.js +63 -0
  37. package/dist/guides/library.js.map +1 -0
  38. package/dist/release/changelog.d.ts +76 -0
  39. package/dist/release/changelog.d.ts.map +1 -1
  40. package/dist/release/changelog.js +114 -0
  41. package/dist/release/changelog.js.map +1 -1
  42. package/dist/release/index.d.ts +1 -1
  43. package/dist/release/index.d.ts.map +1 -1
  44. package/dist/release/index.js +1 -1
  45. package/dist/release/index.js.map +1 -1
  46. package/docs/ReleaseProcess.md +27 -4
  47. package/docs/RoutineOperations.md +20 -12
  48. package/docs/templates/RoutineOperations.md +26 -7
  49. package/package.json +6 -1
@@ -14,9 +14,15 @@ This document is the method. An app's `docs/operations/RoutineOperations.md` lin
14
14
  2. **Its run log** — one line for every run (§3, step 5), newest first.
15
15
  3. **Its standing go-aheads** — any routine the owner has said may read or write production without asking each time, recorded on that routine's row.
16
16
 
17
- Start it from [templates/RoutineOperations.md](templates/RoutineOperations.md): copy it to `docs/operations/RoutineOperations.md`, put the app's name in the title, and fill the register (§5 lists the rows most apps start with). Then add the pointer in §6 to the app's `AGENTS.md`.
17
+ Every app's file has the same three parts, so a reference like "Part 2" means the same thing in each:
18
18
 
19
- The method is not copied into the app. If it needs to change, change it here, so every app changes with it.
19
+ - **Part 1 — The method:** a link here and the four rules an agent needs without leaving the file (read Next due first; never write to production without a yes; how a run is recorded; new routines start Proposed, retired ones are paused), with the status keys.
20
+ - **Part 2 — the register:** 2.1 manual routines, 2.2 automated routines, 2.3 paused.
21
+ - **Part 3 — Run log.**
22
+
23
+ Start it from [templates/RoutineOperations.md](templates/RoutineOperations.md): copy it to `docs/operations/RoutineOperations.md`, put the app's name in the title, and fill the register (§5 lists the rows most apps start with). The template links the app's own `docs/operations/ReleaseProcess.md`; an app without one links the shared [ReleaseProcess.md](https://github.com/Connextar/cx-house/blob/main/docs/ReleaseProcess.md) instead. Then add the pointer in §6 to the app's `AGENTS.md`.
24
+
25
+ Part 1 is a summary, not a copy. If the method needs to change, change it here, so every app changes with it, and change the template's Part 1 if one of the four rules moved.
20
26
 
21
27
  ---
22
28
 
@@ -61,9 +67,9 @@ Every routine has one row, with:
61
67
 
62
68
  ### How the register is laid out
63
69
 
64
- - **Manual routines** — the full table, every field above.
65
- - **Automated routines** — a shorter table (ID, job, what it does, when, status), headed by a sentence saying where to watch them: the app's job-health page, its operational summary email, its host's cron dashboard. Say how often to look (at least weekly) and when to look sooner.
66
- - **Paused** — ID, routine, why paused, since.
70
+ - **2.1 Manual routines** — the full table, every field above.
71
+ - **2.2 Automated routines** — a shorter table (ID, job, what it does, when, status), headed by a sentence saying where to watch them: the app's job-health page, its operational summary email, its host's cron dashboard. Say how often to look (at least weekly) and when to look sooner.
72
+ - **2.3 Paused** — ID, routine, why paused, since.
67
73
 
68
74
  ---
69
75
 
@@ -90,7 +96,7 @@ Every routine has one row, with:
90
96
 
91
97
  ### Retiring a routine
92
98
 
93
- Set it to 🧊 Paused and move it to the Paused table, with the date and the reason. Don't delete it: the run log still points at it, and IDs are never reused.
99
+ Set it to 🧊 Paused and move it to the Paused table (2.3), with the date and the reason. Don't delete it: the run log still points at it, and IDs are never reused.
94
100
 
95
101
  ### Booking runs
96
102
 
@@ -124,17 +130,19 @@ If continuous integration is switched off, add it to the Paused table with the r
124
130
 
125
131
  ## 6. The pointer in `AGENTS.md`
126
132
 
127
- Add this section to the app's `AGENTS.md`, so every agent reads the register before it starts:
133
+ Add this section to the app's `AGENTS.md`, so every agent reads the register before it starts. Replace the bracketed list with the kinds of check in the app's own register, so an agent knows what it's looking for:
128
134
 
129
135
  ```markdown
130
136
  ## Routine operations
131
137
 
132
- - **`docs/operations/RoutineOperations.md` is the register of recurring checks**,
138
+ - **`docs/operations/RoutineOperations.md` is the register of recurring checks** —
139
+ [security rounds, pruning, release gates, the browser sweep, bills, privacy] —
133
140
  with when each last ran and when it's next due. At the start of a task, read its
134
141
  **Next due** column: a routine that is due or overdue runs before new feature
135
142
  work, or the owner says why not.
136
- - After running one, record it as the shared method says
137
- (https://github.com/Connextar/cx-house/blob/main/docs/RoutineOperations.md):
138
- the full result in its record, a line in the run log, and the row's Last run / Next due / Status.
139
- Add a row in the same change set as anything new that needs regular attention.
143
+ - After running one, record it as the shared method says (`@connextar/house`'s
144
+ [`docs/RoutineOperations.md`](https://github.com/Connextar/cx-house/blob/main/docs/RoutineOperations.md)):
145
+ the full result in its record, a line in the run log, and the row's Last run /
146
+ Next due / Status. Add a row in the same change set as anything new that needs
147
+ regular attention.
140
148
  ```
@@ -1,24 +1,43 @@
1
+ <!--
2
+ Copy to docs/operations/RoutineOperations.md and replace "App name".
3
+ The ReleaseProcess.md links assume the app has docs/operations/ReleaseProcess.md.
4
+ If it doesn't, point them at the shared one instead:
5
+ https://github.com/Connextar/cx-house/blob/main/docs/ReleaseProcess.md
6
+ Delete this comment once the file is filled in.
7
+ -->
8
+
1
9
  # App name — Routine Operations
2
10
 
3
- > The recurring checks that keep App name ready, aligned and compliant: what each one is for, how often it runs, how to run it, when it last ran and what it found, and when it's next due. The method — the fields, the status keys, how to run, add, retire and book a routine — is the cohort's, in `@connextar/house`: [`docs/RoutineOperations.md`](https://github.com/Connextar/cx-house/blob/main/docs/RoutineOperations.md). This file holds only App name's register and run log. Sits beside [ReleaseProcess.md](ReleaseProcess.md); [`AGENTS.md`](../../AGENTS.md) points here.
11
+ > The recurring checks that keep App name ready, aligned and compliant: what each one is for, how often it runs, how to run it, when it last ran and what it found, and when it's next due. One place to look, so nothing scheduled gets lost in day-to-day work. Sits beside [ReleaseProcess.md](ReleaseProcess.md); [`AGENTS.md`](../../AGENTS.md) points here.
4
12
 
5
13
  _Last updated: YYYY-MM-DD — first version._
6
14
 
7
- **At the start of a task, read the Next due column.** A 🟨 Due or 🟥 Overdue routine runs before new feature work, or the owner says why not.
15
+ This file follows the cohort's method in `@connextar/house`, [`docs/RoutineOperations.md`](https://github.com/Connextar/cx-house/blob/main/docs/RoutineOperations.md). It holds App name's own register (Part 2) and run log (Part 3).
16
+
17
+ ---
18
+
19
+ ## Part 1 — The method
20
+
21
+ The method — what a routine is, the register's fields, the status keys, how to run, add, retire and book a routine — is the shared [`docs/RoutineOperations.md`](https://github.com/Connextar/cx-house/blob/main/docs/RoutineOperations.md). Change it there, not here. In short:
22
+
23
+ - **At the start of a task, read Part 2's Next due column.** A 🟨 Due or 🟥 Overdue routine runs before new feature work, or the owner says why not.
24
+ - **Run it as its How says; never write to production** unless the How says so and the owner has said yes for this run. Reads against production need a go-ahead too, unless the row records a standing one.
25
+ - **Record it:** the full result in its Record, a line in the run log (Part 3), and the row's Last run, Next due and Status. Release if a status document changed ([ReleaseProcess.md](ReleaseProcess.md)).
26
+ - **New routines start ⚪ Proposed**, in the same change set as whatever needs them; retired ones go to 🧊 Paused, never deleted.
8
27
 
9
28
  Status keys: ✅ On schedule · 🟨 Due · 🟥 Overdue · ⏰ Scheduled · 🤖 Automated · ⚪ Proposed · 🧊 Paused.
10
29
 
11
30
  ---
12
31
 
13
- ## 1. Register
32
+ ## Part 2 — App name's register
14
33
 
15
- ### 1.1 Manual routines
34
+ ### 2.1 Manual routines
16
35
 
17
36
  | ID | Routine | Why | When | How | Record | Last run | Next due | Status |
18
37
  | ------ | ------- | --- | ---- | --- | ------ | -------- | -------- | ------ |
19
38
  | OPS-01 | | | | | | | | |
20
39
 
21
- ### 1.2 Automated routines
40
+ ### 2.2 Automated routines
22
41
 
23
42
  The app runs these itself. The routine here is **watching** them: say where (a job-health page, a summary email, the host's cron dashboard), how often to look, and when to look sooner.
24
43
 
@@ -26,7 +45,7 @@ The app runs these itself. The routine here is **watching** them: say where (a j
26
45
  | --- | --- | ------------ | ---- | ------ |
27
46
  | | | | | |
28
47
 
29
- ### 1.3 Paused
48
+ ### 2.3 Paused
30
49
 
31
50
  | ID | Routine | Why paused | Since |
32
51
  | --- | ------- | ---------- | ----- |
@@ -34,7 +53,7 @@ The app runs these itself. The routine here is **watching** them: say where (a j
34
53
 
35
54
  ---
36
55
 
37
- ## 2. Run log
56
+ ## Part 3 — Run log
38
57
 
39
58
  Newest first. One line a run: date · ID · who · result · follow-up.
40
59
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connextar/house",
3
- "version": "0.15.1",
3
+ "version": "0.16.0",
4
4
  "description": "The pieces every app we build needs and none of them should own a copy of.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -58,6 +58,10 @@
58
58
  "types": "./dist/markdown/index.d.ts",
59
59
  "default": "./dist/markdown/index.js"
60
60
  },
61
+ "./guides": {
62
+ "types": "./dist/guides/index.d.ts",
63
+ "default": "./dist/guides/index.js"
64
+ },
61
65
  "./trail": {
62
66
  "types": "./dist/trail/index.d.ts",
63
67
  "default": "./dist/trail/index.js"
@@ -198,6 +202,7 @@
198
202
  "node": ">=20"
199
203
  },
200
204
  "dependencies": {
205
+ "@radix-ui/react-dialog": "^1.3.1",
201
206
  "@radix-ui/react-dropdown-menu": "^2.1.24",
202
207
  "@radix-ui/react-popover": "^1.1.23",
203
208
  "@tiptap/core": "^3.31.3",