Skip to content

Commit 6049086

Browse files
jsollycursoragent
andcommitted
docs: Local UI verification + add markdownlint gate script
Fleet smoke stanza on AGENTS.md. Add scripts/lint-md.sh, config, and pin markdownlint-cli2 so gate_begin_commit can lint staged markdown. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 5aff63b commit 6049086

6 files changed

Lines changed: 1228 additions & 16 deletions

File tree

.markdownlint-cli2.jsonc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
// Respect .gitignore — never lint generated/gitignored markdown (dist/, .astro/, .vercel/, .venv/, MEMORY.md, generated seeds, node_modules, etc.).
3+
"gitignore": true,
4+
"config": {
5+
// Enable the full default rule set; overrides below opt specific rules out/in.
6+
"default": true,
7+
// MD013 (line-length): disabled — allow long lines / no hard wrap.
8+
"MD013": false,
9+
// MD033 (no-inline-html): disabled — permit raw HTML in Markdown.
10+
"MD033": false,
11+
// MD041 (first-line-h1): disabled — file need not start with a top-level heading.
12+
"MD041": false,
13+
// MD024 (no-duplicate-heading): only flag duplicate headings under the same
14+
// parent, so repeated section names (e.g. "Usage") across different sections are OK.
15+
"MD024": { "siblings_only": true }
16+
},
17+
"ignores": [
18+
"node_modules/**",
19+
// Archival planning/spec records — not active content, not lint-gated.
20+
"docs/plans/**",
21+
"docs/specs/**",
22+
// Vendor runtime dir (never tracked) — not repo content.
23+
".claude/**",
24+
// CLAUDE.md is a symlink to its sibling AGENTS.md (already linted) — skip to avoid double-linting.
25+
"CLAUDE.md",
26+
"**/CLAUDE.md"
27+
]
28+
}

AGENTS.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ Local gate before push: `npm run check && npm run build` (full gate also runs in
1414

1515
When starting the dev server, use background mode:
1616

17-
```
17+
```bash
1818
astro dev --background
1919
```
2020

2121
Manage the background server with `astro dev stop`, `astro dev status`, and `astro dev logs`.
2222

2323
## Documentation
2424

25-
Full documentation: https://docs.astro.build
25+
Full documentation: <https://docs.astro.build>
2626

2727
Consult these guides before working on related tasks:
2828

@@ -32,3 +32,10 @@ Consult these guides before working on related tasks:
3232
- [Adding or managing content](https://docs.astro.build/en/guides/content-collections/)
3333
- [Adding styles or using Tailwind](https://docs.astro.build/en/guides/styling/)
3434
- [Supporting multiple languages](https://docs.astro.build/en/guides/internationalization/)
35+
36+
## Local UI verification
37+
38+
No auth — public UI only. Follow `rules/frontend-verification.md` (fleet smoke: desktop + mobile screenshots, console clean).
39+
40+
- **Dev server:** `astro dev --background` (manage with `astro dev status` / `astro dev logs` / `astro dev stop`). Default local URL is the Astro dev host printed on start (typically <http://localhost:4321>).
41+
- **Auth:** none — public pages only. No `DEFAULT_USER` / `DEFAULT_PASSWORD`.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ User progress is stored only in the browser with `localStorage`. There is no dat
2525

2626
## Hosting
2727

28-
Production: https://learnthefar.com (Vercel, Git-connected to this repo).
28+
Production: <https://learnthefar.com> (Vercel, Git-connected to this repo).
2929

3030
Vercel builds the app with `npm run build` and serves the generated `dist/` directory. The deployment settings are captured in `vercel.json`. Pushes to `main` trigger a production deploy automatically.
3131

0 commit comments

Comments
 (0)