diff --git a/README.md b/README.md index c6144a4..86d4137 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # seal -**Self-healing technical documentation.** seal watches your codebase, detects when a code change makes your docs inaccurate, and either fixes the stale section automatically or flags it for human review — as a local git hook, a GitHub Action, or both. +**Automated documentation healing.** seal watches your codebase, detects when a code change makes your docs inaccurate, and either fixes the stale section automatically or flags it for human review — as a local git hook, a GitHub Action, or both. Every team's docs drift out of sync with the code. seal closes that gap automatically, using an LLM to understand *what* changed and whether it actually invalidates what's written about it — not just that a file touched a function that happens to be mentioned somewhere. diff --git a/package.json b/package.json index 6408626..288be73 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "seal", "private": true, "version": "0.1.0", - "description": "Self-Healing Technical Documentation", + "description": "Automated documentation healing for your codebase", "type": "module", "workspaces": [ "packages/*" diff --git a/packages/action/action.yml b/packages/action/action.yml index 9254d84..eddc49c 100644 --- a/packages/action/action.yml +++ b/packages/action/action.yml @@ -1,4 +1,4 @@ -name: 'seal - Self-Healing Technical Documentation' +name: 'seal - Automated Documentation Healing' description: 'Detects code changes that make documentation stale, auto-fixes high-confidence cases via a PR, and flags the rest for human review.' inputs: gemini-api-key: diff --git a/packages/action/package.json b/packages/action/package.json index a2e8fc6..1773258 100644 --- a/packages/action/package.json +++ b/packages/action/package.json @@ -2,7 +2,7 @@ "name": "@seal/action", "version": "0.1.0", "private": true, - "description": "seal GitHub Action - self-healing technical documentation CI integration", + "description": "seal GitHub Action - automated documentation healing CI integration", "type": "module", "main": "dist/index.js", "files": [ diff --git a/packages/cli/README.md b/packages/cli/README.md index 8025b9a..fac9f5f 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -1,6 +1,6 @@ # @seal/cli -Self-healing technical documentation, as a local git hook. Detects when a code change makes your Markdown docs stale, auto-fixes high-confidence cases, and flags the rest for review — before you commit. +Automated documentation healing, as a local git hook. Detects when a code change makes your Markdown docs stale, auto-fixes high-confidence cases, and flags the rest for review — before you commit. ## Install diff --git a/packages/cli/package.json b/packages/cli/package.json index 3e0670c..38fc091 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,7 +1,7 @@ { "name": "@seal/cli", "version": "0.1.0", - "description": "seal CLI - self-healing technical documentation as a local git hook", + "description": "seal CLI - automated documentation healing as a local git hook", "type": "module", "license": "MIT", "homepage": "https://github.com/dakshcodez/seal#readme",