Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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/*"
Expand Down
2 changes: 1 addition & 1 deletion packages/action/action.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion packages/action/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/cli/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
Loading