|
49 | 49 | under real Mimir domains, private documents, generated `.pid` files, committed secrets, internal |
50 | 50 | GTM/pricing ledgers, or wording that presents tracked MIT source as proprietary or closed source. |
51 | 51 | `pnpm public:smoke` enforces the cheap checks. |
| 52 | +- Root `llms.txt` (the [llms.txt](https://llmstxt.org/) convention) and `context7.json` are the |
| 53 | + LLM/Context7-facing doc index for this repository. Update `llms.txt` when adding or removing a |
| 54 | + top-level `docs/*.md` file worth surfacing to agents, and keep `context7.json`'s |
| 55 | + `excludeFolders`/`excludeFiles` in sync with new generated-output or private-data directories. |
| 56 | + Registering the repo on context7.com (so it resolves through `resolve-library-id`) is a manual |
| 57 | + step on their site; these files only prepare the repo for that step. |
| 58 | +- The bundled `mimir` skill is directly installable from this monorepo's nested path with the |
| 59 | + [skills.sh](https://skills.sh) CLI (`npx skills add <repo-url>/tree/main/packages/mimir-core/skills/mimir`), |
| 60 | + since that CLI supports a direct subdirectory path. If `packages/mimir-core/skills/` moves, update |
| 61 | + the command documented in the README's "Agent Skills And MCP" section. |
52 | 62 | - `packages/mimir-ui` is the shared UI/style foundation adapted from the WorkoutGen landing/UI |
53 | 63 | approach. It provides the common Tailwind theme and React primitives for both the landing and the |
54 | 64 | Tauri app; do not import WorkoutGen product copy, assets, analytics, or secrets. |
|
144 | 154 | `KB_PDF_OCR_COMMAND` and `KB_IMAGE_OCR_COMMAND` remain legacy aliases only. |
145 | 155 | - Keep the repository as a simple pnpm workspace monorepo. Add Turbo only if multiple packages or |
146 | 156 | apps start needing task caching/orchestration beyond `pnpm --filter`. |
| 157 | +- The Node.js version is pinned once, in `mise.toml` (via [mise](https://mise.jdx.dev/)). Bump the |
| 158 | + version there only, not as a hardcoded `node-version` in individual workflow steps. CI |
| 159 | + (`ci.yml`, `native-app-build.yml`) installs mise with the official `curl https://mise.run | sh` |
| 160 | + script in a plain `run:` step, not the `jdx/mise-action` marketplace action — this repo's Actions |
| 161 | + permissions are restricted to `actions/*`, `github/codeql-action/*`, and verified creators, and |
| 162 | + `jdx/mise-action` does not qualify. `npm-publish.yml` keeps `actions/setup-node` instead, because |
| 163 | + that step also wires the npm registry `.npmrc` for publishing; keep its `node-version` in sync |
| 164 | + with `mise.toml` by hand. pnpm stays pinned via Corepack through `packageManager` in |
| 165 | + `package.json`, not duplicated in `mise.toml`. |
147 | 166 | - Keep Mimir core free of Ollama. `embeddingProvider: "local-hash"` supports ingestion, search, MCP, |
148 | 167 | and cited retrieval without a model server, but it must not be described as equivalent to semantic |
149 | 168 | retrieval. `embeddingProvider: "transformers"` is the optional semantic embedding path. |
@@ -233,10 +252,14 @@ General principles (KISS, DRY, YAGNI, SOLID) as applied in this codebase. Match |
233 | 252 | - `packages/mimir-core/skills/mimir-audio-summary/SKILL.md` is the optional bundled audio-summary skill. |
234 | 253 | - `packages/mimir-core/skills/mimir-markdown-report/SKILL.md` is the optional bundled Markdown-report |
235 | 254 | skill. |
236 | | -- `mimir setup` must keep generating agent-specific MCP helpers for easy local use: |
| 255 | +- `mimir setup` must keep generating agent-specific MCP helpers for easy local use by default: |
237 | 256 | `.mimir/claude-mcp-server.json` for `claude mcp add-json`, `.mimir/codex-mcp.toml` for Codex |
238 | 257 | config layers, `.mimir/kimi-mcp.json` for Kimi, `.mimir/opencode.jsonc` for OpenCode, and |
239 | | - `.mimir/cline-mcp.json` for Cline. |
| 258 | + `.mimir/cline-mcp.json` for Cline. Keep `--agents` available on setup/install-skill so a target |
| 259 | + repository can generate only the helpers it uses and remove stale unselected helpers. |
| 260 | +- Keep `--mcp-name`, `--mcp-command`, and repeatable `--mcp-arg` available on setup/install-skill |
| 261 | + so repositories can generate MCP helper files for a stable server name or local wrapper script |
| 262 | + without post-processing `.mimir/`. |
240 | 263 | - `mimir install-agent` owns native skill discovery for the main supported coding agents. Keep |
241 | 264 | `--agents claude|codex|kimi|opencode|cline` targeted so a user can install only the agent they use, |
242 | 265 | with project scope by default and user scope available through `--scope user`. |
|
0 commit comments