codealmanac 0.1.1 → 0.1.2
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/dist/codealmanac.js +983 -391
- package/dist/codealmanac.js.map +1 -1
- package/guides/mini.md +187 -0
- package/guides/reference.md +599 -0
- package/package.json +2 -1
- package/prompts/bootstrap.md +55 -10
package/prompts/bootstrap.md
CHANGED
|
@@ -69,30 +69,50 @@ Keep the README around 50-100 lines. Enough to set the tone, not a comprehensive
|
|
|
69
69
|
|
|
70
70
|
One page per anchor. Each stub has:
|
|
71
71
|
|
|
72
|
+
> **DO NOT copy the example below literally.** The slugs, paths, and
|
|
73
|
+
> `[[doppler]]` reference are illustrative of the *shape* of a stub, not
|
|
74
|
+
> content to reproduce. Every wikilink, every file path, and every topic
|
|
75
|
+
> in a real stub must come from the repo you're actually scanning.
|
|
76
|
+
|
|
72
77
|
```yaml
|
|
73
78
|
---
|
|
74
|
-
title:
|
|
75
|
-
topics: [
|
|
79
|
+
title: <Real dependency or system name from this repo>
|
|
80
|
+
topics: [<real topics from the DAG you're defining>]
|
|
76
81
|
files:
|
|
77
|
-
-
|
|
78
|
-
-
|
|
79
|
-
- backend/src/models/
|
|
82
|
+
- <real path that exists in this repo>
|
|
83
|
+
- <real path that exists in this repo>
|
|
80
84
|
---
|
|
81
85
|
|
|
82
|
-
#
|
|
86
|
+
# <Real name>
|
|
83
87
|
|
|
84
|
-
|
|
88
|
+
<One paragraph describing what this is IN THIS REPO, based on what you
|
|
89
|
+
actually read. Not generic docs for the dependency.>
|
|
85
90
|
|
|
86
91
|
<!-- stub: the writer will fill this in over sessions -->
|
|
87
92
|
|
|
88
93
|
## Where we use it
|
|
89
|
-
-
|
|
90
|
-
-
|
|
94
|
+
- `<real/path.ts>` — <what it does here>
|
|
95
|
+
- `<real/dir/>` — <what it does here>
|
|
91
96
|
|
|
92
97
|
## Configuration
|
|
93
|
-
|
|
98
|
+
<Only include a Configuration section if you actually found
|
|
99
|
+
configuration while scanning. Reference real env vars, real config files.
|
|
100
|
+
If you mention another anchor page, only use `[[slug]]` when you have
|
|
101
|
+
actually created that anchor in this same bootstrap run.>
|
|
94
102
|
```
|
|
95
103
|
|
|
104
|
+
For illustration only (do NOT emit this as a page), a filled-in stub for
|
|
105
|
+
a Supabase-using repo would look like:
|
|
106
|
+
|
|
107
|
+
title: Supabase
|
|
108
|
+
topics: [stack, database]
|
|
109
|
+
files: [src/lib/supabase.ts, docker-compose.yml]
|
|
110
|
+
# body references real files from that specific repo
|
|
111
|
+
|
|
112
|
+
Again: the names, paths, and topics above are examples of the *pattern*.
|
|
113
|
+
Never ship a page that references `src/lib/supabase.ts` unless that file
|
|
114
|
+
actually exists in the repo you just scanned.
|
|
115
|
+
|
|
96
116
|
Stubs are fine. They should have:
|
|
97
117
|
- **Title** (what the thing is)
|
|
98
118
|
- **Topics** (at minimum the domain topic)
|
|
@@ -112,6 +132,31 @@ Create the topics you propose. Set parent relationships. If a topic is obviously
|
|
|
112
132
|
|
|
113
133
|
Don't over-engineer the DAG. Flat is fine to start. The writer and reviewer will deepen it as the wiki grows.
|
|
114
134
|
|
|
135
|
+
## No placeholder wikilinks — ever
|
|
136
|
+
|
|
137
|
+
Every `[[...]]` you emit must reference a real page or real file in this
|
|
138
|
+
repo. Do not include placeholder slugs like `[[some-page]]`,
|
|
139
|
+
`[[example-flow]]`, `[[your-thing]]`, or illustrative cross-wiki refs
|
|
140
|
+
like `[[openalmanac:supabase]]`, `[[wiki-name:slug]]`,
|
|
141
|
+
`[[example-wiki:slug]]`.
|
|
142
|
+
|
|
143
|
+
Rules:
|
|
144
|
+
|
|
145
|
+
- `[[page-slug]]` — only if you are creating that exact page in this same
|
|
146
|
+
bootstrap run. Page slugs are kebab-cased filenames under
|
|
147
|
+
`.almanac/pages/`.
|
|
148
|
+
- `[[src/path/to/file.ts]]` — only if the file actually exists in this
|
|
149
|
+
repo. Verify with `Read` or `Glob` before writing the link.
|
|
150
|
+
- `[[src/path/to/dir/]]` — only if the directory actually exists.
|
|
151
|
+
- `[[wiki:slug]]` cross-wiki references — **do not emit any during
|
|
152
|
+
bootstrap**. Cross-wiki refs require the target wiki to be registered
|
|
153
|
+
on this machine; a fresh bootstrap has no way to know what other wikis
|
|
154
|
+
exist.
|
|
155
|
+
|
|
156
|
+
If you're tempted to link to a concept but aren't sure whether a page
|
|
157
|
+
for it will exist, mention the concept in prose instead. The writer will
|
|
158
|
+
turn it into a wikilink later when the anchor actually exists.
|
|
159
|
+
|
|
115
160
|
## Scope discipline
|
|
116
161
|
|
|
117
162
|
This pass should produce maybe 5-15 pages, not 50. If you're writing more than 20 pages, you're probably including things that aren't anchors. Re-read the "What's NOT an anchor" list.
|