docs: verified usage examples and Context7 config (#46)

Adds a Context7 indexing config, tightens README usage examples to source-verified behaviour, and adds an isolated docs-tests package that compiles/runs the marked README example against the released package in CI (Node 22).

Author: melissa-lomray

.github/workflows/docs-check.yml

@@ -0,0 +1,32 @@
+name: Documentation checks
+
+on:
+  pull_request:
+    paths:
+      - 'README.md'
+      - 'context7.json'
+      - 'docs-tests/**'
+      - '.github/workflows/docs-check.yml'
+  push:
+    branches: [prod]
+    paths:
+      - 'README.md'
+      - 'context7.json'
+      - 'docs-tests/**'
+      - '.github/workflows/docs-check.yml'
+
+permissions:
+  contents: read
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - run: npm ci --ignore-scripts --legacy-peer-deps
+        working-directory: docs-tests
+      - run: npm test
+        working-directory: docs-tests

context7.json

@@ -1,4 +1,24 @@
 {
   "url": "https://context7.com/lomray-software/react-mobx-manager",
-  "public_key": "pk_9IAtRK9ehH9s9ktsgMjAJ"
+  "public_key": "pk_9IAtRK9ehH9s9ktsgMjAJ",
+  "$schema": "https://context7.com/schema/context7.json",
+  "branch": "prod",
+  "folders": [
+    "docs"
+  ],
+  "excludeFolders": [
+    "node_modules",
+    "lib",
+    "src",
+    "__tests__",
+    "__type_tests__",
+    "docs-tests",
+    ".github",
+    "docs/.vitepress"
+  ],
+  "excludeFiles": [
+    "CHANGELOG.md",
+    "LICENSE.md",
+    "CODE_OF_CONDUCT.md"
+  ]
 }

docs-tests/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+.generated/

docs-tests/README.md

@@ -0,0 +1,17 @@
+# Documentation checks
+
+From this directory:
+
+```sh
+npm ci --ignore-scripts --legacy-peer-deps
+npm test
+```
+
+The isolated fixture pins released dependencies, not local source. It validates
+context7.json against the fetched official schema. For repositories with a marked
+README example it extracts that block, runs a strict TypeScript check (skipping
+external declaration checking), then runs a targeted smoke test. It is not the
+full package suite, an exhaustive peer compatibility matrix, or an index refresh.
+The registry lockfile records transitive versions. Peer auto-installation is
+disabled so the tested combination stays explicit. Public network access is
+needed for npm installation and the Context7 schema read.

docs-tests/check.mjs

@@ -0,0 +1,17 @@
+import assert from 'node:assert/strict';
+import { readFile } from 'node:fs/promises';
+import Ajv from 'ajv';
+
+const root = new URL('../', import.meta.url);
+const config = JSON.parse(await readFile(new URL('context7.json', root), 'utf8'));
+const schemaResponse = await fetch('https://context7.com/schema/context7.json');
+assert.equal(schemaResponse.status, 200);
+const schema = await schemaResponse.json();
+const ajv = new Ajv({ strict: false, formats: { uri: true } });
+const validate = ajv.compile(schema);
+assert.ok(validate(config), JSON.stringify(validate.errors));
+assert.equal(config.branch, 'prod');
+assert.ok(config.excludeFolders.includes('docs-tests'));
+assert.deepEqual(config.folders, ['docs']);
+assert.ok(config.url && config.public_key, 'Preserve existing ownership fields');
+console.log('PASS: Context7 schema, stable branch, docs path and existing ownership');

docs-tests/package-lock.json

@@ -0,0 +1,11 @@
+{
+  "name": "react-mobx-manager-docs-tests",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "test": "node check.mjs"
+  },
+  "devDependencies": {
+    "ajv": "8.17.1"
+  }
+}

docs-tests/package.json

@@ -39,6 +39,7 @@
   },
   "exclude": [
     "node_modules",
+    "docs-tests",
     "lib",
     "commitlint.config.js",
     "nyc.config.js",