Commit 7a45388
authored
Delete docs.ps1: it is an installed file, not a committed one (#14)
Resolves W-D6 for docs.ps1. The repository was carrying a hand-written copy of
a file the documentation tooling generates.
The item was filed under a wrong premise and correcting it is what resolved it.
docs.ps1, docs/Dockerfile and docs/.dockerignore all date from the initial
commit -- before the template was installed in W0, which wrote only build/ and
.config/ -- so they were never stale vendored copies. And setup-docs.ps1
rewrites docs.ps1 with four substitutions, so the installed form never matches
the raw template and the byte-comparison that flagged this was never valid.
docs.ps1 is therefore a generated file, and committing a hand-written
substitute meant carrying a permanent invisible fork of something the tooling
owns. Invoke-SetupDocs writes the real one.
Checked rather than assumed: nothing under .github/workflows executes it; all
seventeen references are prose or absolute URLs so no relative link resolves to
it; and upstream's parameter set is a superset of the deleted one, so every
documented command still works once the installer runs. README.md therefore
needed no edit, which also avoided regenerating docs/src/pages/index.md by hand.
The gain is the one flagged when this was filed: the installed docs.ps1
regenerates the README-derived site root every run, retiring the by-hand
replication needed because there is no pwsh in the agent environment. The cost,
recorded in CLAUDE.md and the contributor guide: until the next installer run,
./docs.ps1 does not exist in a fresh checkout.
docs/Dockerfile and docs/.dockerignore are retained -- they are the Docker
build context the preview depends on, so removing them would leave no way to
build the site locally at all.1 parent 4f600fa commit 7a45388
4 files changed
Lines changed: 53 additions & 88 deletions
File tree
- docs/docs/guide
- plans
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
101 | 101 | | |
102 | 102 | | |
103 | 103 | | |
104 | | - | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
105 | 110 | | |
106 | 111 | | |
107 | 112 | | |
| |||
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
21 | 30 | | |
22 | 31 | | |
23 | 32 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | | - | |
| 14 | + | |
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| |||
213 | 213 | | |
214 | 214 | | |
215 | 215 | | |
216 | | - | |
217 | | - | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
218 | 244 | | |
219 | 245 | | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
220 | 255 | | |
221 | 256 | | |
222 | 257 | | |
| |||
0 commit comments