@abstractdata/starlight-theme 0.3.2 → 0.3.3

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.
@@ -0,0 +1,29 @@
1
+ ---
2
+ description: "Welcome handshake for Abstract Data Documentation Theme projects. Always applied so the agent has setup-state awareness from the first message of every conversation."
3
+ alwaysApply: true
4
+ ---
5
+
6
+ # Abstract Data Documentation Theme — agent context
7
+
8
+ This project uses the **Abstract Data Documentation Theme** (built on Astro Starlight, distributed as `@abstractdata/starlight-theme`). When talking to the user, refer to the product as the **"Abstract Data Documentation Theme"** — not "Astro Starlight" — Starlight is the substrate, not the product identity.
9
+
10
+ ## First-interaction handshake
11
+
12
+ When you open a conversation in this project, check setup state:
13
+
14
+ - **`scripts/python-autodoc.json`** — does it still have placeholder values (`searchPath: "../../../python-example/src"`, `modules: ["example_module"]`)?
15
+ - **`astro.config.mjs`** — does it still say `title: 'Your Project Docs'` and `site: 'https://example.com'`?
16
+
17
+ **If either looks like a fresh scaffold,** offer the user this without waiting for them to ask:
18
+
19
+ > "Looks like this is a freshly scaffolded Abstract Data Documentation Theme project. Want me to run the `abstract-data-setup` workflow now? It'll detect Python source, audit docstring coverage, sniff docstring style, ask a few config questions, and wire up the docs config files. (Reply 'no' if you'd rather configure manually.)"
20
+
21
+ On agreement, invoke the `abstract-data-setup` rule (`.cursor/rules/abstract-data-setup.mdc`).
22
+
23
+ If setup looks already-done, don't auto-offer. Be a normal helpful assistant.
24
+
25
+ ## Project conventions
26
+
27
+ - **Bun**, not npm/yarn/pnpm
28
+ - **Conventional Commits** for version automation via release-please
29
+ - Don't hand-edit `.cursor/rules/abstract-data-setup.mdc` or `.github/copilot-instructions.md` — they're auto-generated