diff --git a/CLAUDE.md b/CLAUDE.md index 5f188101..a50231ab 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -196,7 +196,7 @@ For setup wizards where the target database may not exist yet, use `testConnecti | `docs/modeling/data-flows.md` | SSADM data flow diagrams | atomic-writing | | `docs/modeling/best-practices.md` | modeling best practices | atomic-writing | | `docs/modeling/branding.md` | model branding | atomic-writing | -| `docs/modeling/modeling-skill.md` | /noorm-modeling skill | atomic-writing | +| `docs/modeling/modeling-skill.md` | /ignatius-modeling skill | atomic-writing | | `docs/modeling/reverse-engineering.md` | reverse-engineering via MCP | atomic-writing | | `docs/reference/sdk.md` | SDK API reference, withSchema, impersonation, routines | terse-technical | | `packages/sdk/README.md` | npm SDK readme, install, usage, schema scoping | terse-technical | diff --git a/docs/modeling/data-flows.md b/docs/modeling/data-flows.md index 291d4008..6a6e57a0 100644 --- a/docs/modeling/data-flows.md +++ b/docs/modeling/data-flows.md @@ -171,7 +171,7 @@ Hovering an edge that carries data reveals a tooltip listing everything crossing ## Authoring with the skill -The [`noorm-modeling` skill](/modeling/modeling-skill) has two doors into flows. `/noorm-modeling flow` walks you through a diagram step by step when you can already name your processes. `/noorm-modeling discover` interviews you about how the business runs and generates both the entities and the flows. Both verify their output with `ignatius validate`. +The [`ignatius-modeling` skill](/modeling/modeling-skill) has two doors into flows. `/ignatius-modeling flow` walks you through a diagram step by step when you can already name your processes. `/ignatius-modeling discover` interviews you about how the business runs and generates both the entities and the flows. Both verify their output with `ignatius validate`. ## Related diff --git a/docs/modeling/entities.md b/docs/modeling/entities.md index e3427920..c89a93d1 100644 --- a/docs/modeling/entities.md +++ b/docs/modeling/entities.md @@ -19,7 +19,7 @@ If you want an agent reasoning in those terms alongside you, there is a separate npx skills add https://github.com/damusix/skills --skill idef1x ``` -It advises on method. The [`noorm-modeling` skill](/modeling/modeling-skill) writes the files. Neither is required to use ignatius, and the rest of this page assumes neither. +It advises on method. The [`ignatius-modeling` skill](/modeling/modeling-skill) writes the files. Neither is required to use ignatius, and the rest of this page assumes neither. ::: diff --git a/docs/modeling/index.md b/docs/modeling/index.md index 817cee48..18f07ec5 100644 --- a/docs/modeling/index.md +++ b/docs/modeling/index.md @@ -51,7 +51,7 @@ The source is markdown with YAML frontmatter, which suits both readers. A stakeholder gets the rendered app: a diagram they can explore, a dictionary they can search, and prose that explains the business meaning rather than the storage layout. `ignatius export` writes all three views into one self-contained HTML file with no external dependencies, so a reviewer opens it from `file://` and needs nothing installed. -A coding agent gets plain text it can read and write directly. ignatius comes with the [`noorm-modeling` skill](/modeling/modeling-skill) for Claude Code, which authors entity and flow files through guided Q&A and verifies each one with `ignatius validate` before moving on. +A coding agent gets plain text it can read and write directly. ignatius comes with the [`ignatius-modeling` skill](/modeling/modeling-skill) for Claude Code, which authors entity and flow files through guided Q&A and verifies each one with `ignatius validate` before moving on. ## The workflow diff --git a/docs/modeling/installation.md b/docs/modeling/installation.md index c17f9ecf..aaa88824 100644 --- a/docs/modeling/installation.md +++ b/docs/modeling/installation.md @@ -1,6 +1,6 @@ --- title: Installing ignatius -description: Install the ignatius binary and the noorm-modeling skill, then serve, validate, and export your first model. +description: Install the ignatius binary and the ignatius-modeling skill, then serve, validate, and export your first model. --- # Installing ignatius @@ -77,13 +77,13 @@ ignatius update --yes # install without prompting, for scripts ## The modeling skill -To author models from Claude Code, install the `noorm-modeling` skill with the [`skills`](https://www.npmjs.com/package/skills) CLI. +To author models from Claude Code, install the `ignatius-modeling` skill with the [`skills`](https://www.npmjs.com/package/skills) CLI. ```bash -npx skills add https://github.com/noormdev/ignatius --skill noorm-modeling +npx skills add https://github.com/noormdev/ignatius --skill ignatius-modeling ``` -That adds the skill to the current project's `.claude/skills/`. Add `-g` to install it globally for every project on the machine. Reload skills in Claude Code and `/noorm-modeling` becomes available. See [The modeling skill](/modeling/modeling-skill) for what each mode does. +That adds the skill to the current project's `.claude/skills/`. Add `-g` to install it globally for every project on the machine. Reload skills in Claude Code and `/ignatius-modeling` becomes available. See [The modeling skill](/modeling/modeling-skill) for what each mode does. ## Serve a model diff --git a/docs/modeling/modeling-skill.md b/docs/modeling/modeling-skill.md index a1576d5c..6059da12 100644 --- a/docs/modeling/modeling-skill.md +++ b/docs/modeling/modeling-skill.md @@ -1,12 +1,12 @@ --- title: The modeling skill -description: /noorm-modeling authors ignatius entities and data flow diagrams through guided Q&A in Claude Code, and verifies each file with ignatius validate. +description: /ignatius-modeling authors ignatius entities and data flow diagrams through guided Q&A in Claude Code, and verifies each file with ignatius validate. --- # The modeling skill -`/noorm-modeling` is a Claude Code skill that authors a model through question and answer, then checks its own work. It writes one entity, a data flow diagram, a fresh model skeleton, or a full discovery session that works the model out from how your business runs. +`/ignatius-modeling` is a Claude Code skill that authors a model through question and answer, then checks its own work. It writes one entity, a data flow diagram, a fresh model skeleton, or a full discovery session that works the model out from how your business runs. The skill exists because the hard part of modeling is not the YAML. It is knowing which questions to ask, in which order, and noticing when an answer contradicts an earlier one. The skill carries that interview structure, and you supply the domain knowledge. @@ -17,10 +17,10 @@ The skill exists because the hard part of modeling is not the YAML. It is knowin ```bash -npx skills add https://github.com/noormdev/ignatius --skill noorm-modeling +npx skills add https://github.com/noormdev/ignatius --skill ignatius-modeling ``` -That adds `noorm-modeling` to the current project's `.claude/skills/`. Add `-g` to install it globally for every project on the machine. Reload skills in Claude Code and `/noorm-modeling` becomes available. +That adds `ignatius-modeling` to the current project's `.claude/skills/`. Add `-g` to install it globally for every project on the machine. Reload skills in Claude Code and `/ignatius-modeling` becomes available. ## Modes @@ -28,11 +28,11 @@ That adds `noorm-modeling` to the current project's `.claude/skills/`. Add `-g` | Invocation | What it does | |---|---| -| `/noorm-modeling entity` | Interactive Q&A to author one entity file | -| `/noorm-modeling model` | Bootstrap a new model skeleton: `ignatius.yml`, group files, directories | -| `/noorm-modeling flow` | Interactive Q&A to author a [data flow diagram](/modeling/data-flows) | -| `/noorm-modeling discover` | Socratic interview that works the model out from how your business runs, generating entities and flows | -| `/noorm-modeling` | Prompts you to choose a mode | +| `/ignatius-modeling entity` | Interactive Q&A to author one entity file | +| `/ignatius-modeling model` | Bootstrap a new model skeleton: `ignatius.yml`, group files, directories | +| `/ignatius-modeling flow` | Interactive Q&A to author a [data flow diagram](/modeling/data-flows) | +| `/ignatius-modeling discover` | Socratic interview that works the model out from how your business runs, generating entities and flows | +| `/ignatius-modeling` | Prompts you to choose a mode | ## Choosing between flow and discover diff --git a/docs/modeling/reverse-engineering.md b/docs/modeling/reverse-engineering.md index 70240365..bbb049b5 100644 --- a/docs/modeling/reverse-engineering.md +++ b/docs/modeling/reverse-engineering.md @@ -8,7 +8,7 @@ description: Point an agent at a database you already run and have it extract an Most databases worth modeling already exist. The schema is in production, the reasoning behind it left with someone two jobs ago, and the only description of it is the DDL. -You do not have to model that by hand. noorm exposes the schema to a coding agent over MCP, and the [`noorm-modeling` skill](/modeling/modeling-skill) knows how to turn what it reads into entity and flow files. Your job is to set up the access, keep it read-only, and review what comes back. +You do not have to model that by hand. noorm exposes the schema to a coding agent over MCP, and the [`ignatius-modeling` skill](/modeling/modeling-skill) knows how to turn what it reads into entity and flow files. Your job is to set up the access, keep it read-only, and review what comes back. The result is an ignatius model of the system you already run: a diagram to hand to people, a dictionary of what every table is for, and a base to plan the next change against. @@ -37,7 +37,7 @@ The [`idef1x` skill](https://www.skills.sh/damusix/skills/idef1x) carries the me - noorm installed, with a config that connects to the database ([installation](/getting-started/installation)) - ignatius installed ([installation](/modeling/installation)) -- The `noorm-modeling` skill, and optionally the noorm skill for SDK and CLI conventions +- The `ignatius-modeling` skill, and optionally the noorm skill for SDK and CLI conventions - An agent harness that speaks MCP, such as Claude Code or Cursor @@ -47,7 +47,7 @@ The [`idef1x` skill](https://www.skills.sh/damusix/skills/idef1x) carries the me A model root is any folder with an `ignatius.yml` in it. Let the skill scaffold one: ```bash -/noorm-modeling model +/ignatius-modeling model ``` That writes `ignatius.yml`, the group files, and the directories. To do it by hand, a one-line `ignatius.yml` is a valid model root: @@ -140,7 +140,7 @@ Then check the count. Ask the agent, or run it yourself, for the table list noor Launch the harness and point it at both the database and the model root: ``` -/noorm-modeling discover +/ignatius-modeling discover ``` `discover` interviews you when nothing exists yet. When a real system is available it reads that instead, and interviews you only about the judgment calls the schema cannot answer. Tell it where the model root is and that noorm's MCP server is connected.