Commit 2ac862d
committed
docs: put back the words that page descriptions were missing
Descriptions are generated from each page's first paragraph, and inline code
spans were dropped rather than unwrapped - so the sentences survived and the
nouns did not:
"is the low-level database query interface. It re-exports ; most ..."
"This guide covers managing Bun's lockfile () in your Stacks ..."
The first lost `@stacksjs/query-builder` and `bun-query-builder`, which is why
it begins with "is" and re-exports nothing at all. The second lost `bun.lock`
and kept the brackets around the hole. Both are search-result and social-preview
text, so they were the version of the page most people saw first.
Rebuilt from the paragraphs they were taken from, with the code unwrapped
instead of removed. `docs/basics/routing.md` was the third of these and was
fixed in e679e1b, where the description had been two lines of TypeScript.
`docs-frontmatter-intact.test.ts` checks only signatures that cannot occur in
real prose: a literal `\n`, a space before a semicolon, and a space before empty
parentheses. Two likelier-looking rules were tried and rejected - "starts with a
lowercase verb" flags 61 perfectly good descriptions ("The Coupons module in the
Commerce package ..."), and bare `()` flags a legitimate `validateSkill()`.
`docs/marketing/product-hunt.md` has no frontmatter at all. Left alone: it is an
internal launch-kit document, the only file in `docs/marketing/`, and not in the
site nav.1 parent 4841177 commit 2ac862d
3 files changed
Lines changed: 75 additions & 2 deletions
File tree
- docs
- bootcamp/how-to
- packages
- storage/framework/core/buddy/tests
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
Lines changed: 73 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
0 commit comments