Skip to content

Commit 858c99f

Browse files
Claudejeduden
andauthored
Update docs to remove archetype references
Agent-Logs-Url: https://github.com/jeduden/mdsmith/sessions/456d9e30-3668-49b8-9a42-1b286b593ef5 Co-authored-by: jeduden <1117699+jeduden@users.noreply.github.com>
1 parent 77974f6 commit 858c99f

5 files changed

Lines changed: 1 addition & 86 deletions

File tree

CLAUDE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@ sort: path
1717
header: ""
1818
row: "- [{summary}]({filename})"
1919
?>
20-
- [How generated sections work — markers, directives, and fix behavior.](docs/background/archetypes/generated-section/README.md)
21-
- [Shared patterns (archetypes) reused across multiple linting rules.](docs/background/archetypes/README.md)
2220
- [How "flavor" (a property of the renderer), "rule" (a single check), "convention" (a project-wide bundle), and "kind" (a per-file role tag) differ in mdsmith, the cases where they overlap, and how the four concepts compose.](docs/background/concepts/flavor-rule-convention-kind.md)
21+
- [How generated sections work — markers, directives, and fix behavior.](docs/background/concepts/generated-section.md)
2322
- [How the placeholder vocabulary lets rules treat template tokens as opaque rather than flagging them as content violations.](docs/background/concepts/placeholder-grammar.md)
2423
- [Comparison of mdsmith with other Markdown linters and formatters.](docs/background/markdown-linters.md)
2524
- [Codecov coverage gate and CI status checks.](docs/development/coverage.md)

docs/background/archetypes/README.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
File renamed without changes.

docs/guides/directives/enforcing-structure.md

Lines changed: 0 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -90,61 +90,6 @@ directive has no effect`.
9090
For full reference, see
9191
[MDS020 required-structure](../../../internal/rules/MDS020-required-structure/README.md).
9292

93-
## Archetype templates
94-
95-
Instead of authoring `schema: path/to/schema.md` for
96-
every override, collect reusable schemas in an
97-
archetype directory and refer to them by name.
98-
99-
### Bootstrap the directory
100-
101-
```text
102-
mdsmith archetypes init
103-
```
104-
105-
This creates `./archetypes/` by default. Passing a
106-
directory name creates exactly that directory — for
107-
example, `mdsmith archetypes init templates` creates
108-
`./templates/`. The directory gets an `example.md`
109-
schema and a `README.md`. `init` does not touch
110-
`.mdsmith.yml`; add the printed snippet yourself.
111-
112-
### Register roots and select an archetype
113-
114-
```yaml
115-
archetypes:
116-
roots:
117-
- archetypes
118-
119-
overrides:
120-
- files: ["stories/**/*.md"]
121-
rules:
122-
required-structure:
123-
archetype: story
124-
```
125-
126-
`archetypes.roots` is a list of directories searched
127-
in order; earlier roots shadow later ones. When the
128-
key is omitted, the single root `./archetypes` is
129-
used.
130-
131-
### Inspect archetypes
132-
133-
```text
134-
mdsmith archetypes list # one per line: "<name>\t<path>"
135-
mdsmith archetypes show <name> # print schema source
136-
mdsmith archetypes path <name> # print resolved path
137-
```
138-
139-
`archetype` and `schema` are mutually exclusive.
140-
Schema files can use `<?include?>`, but in
141-
`required-structure` those include paths are
142-
currently resolved relative to the process working
143-
directory, not the archetype file's directory. Keep
144-
archetype schemas self-contained, or run `mdsmith`
145-
from the project root when an archetype schema uses
146-
`<?include?>`.
147-
14893
## Allowing intentional empty sections
14994

15095
Some sections are intentionally left empty (for

docs/reference/cli.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ mdsmith <command> [flags] [files...]
1919
| `help` | Show help for rules/topics |
2020
| `metrics` | List and rank shared metrics |
2121
| `merge-driver` | Git merge driver for regenerable sections |
22-
| `archetypes` | Scaffold, list, show, and locate archetypes |
2322
| `kinds` | Inspect declared kinds and resolve config |
2423
| `init` | Generate `.mdsmith.yml` |
2524
| `version` | Print version, exit |
@@ -155,22 +154,6 @@ records the layers that set the leaf, in chain order:
155154
{"source": "overrides[0]", "value": 900}]}]}
156155
```
157156

158-
## `archetypes` Subcommands
159-
160-
| Subcommand | Description |
161-
|---------------|----------------------------------------------|
162-
| `init [dir]` | Scaffold archetype dir with example + README |
163-
| `list` | Print discovered archetypes (name + path) |
164-
| `show <name>` | Print raw schema source to stdout |
165-
| `path <name>` | Print resolved filesystem path |
166-
167-
Archetype roots come from the top-level
168-
`archetypes.roots` key in `.mdsmith.yml`. When absent,
169-
`./archetypes` is used. `init` never mutates the
170-
config file; it prints the snippet to add manually.
171-
`list` exits `1` when no archetypes are discovered;
172-
`show` and `path` exit `2` on unknown names.
173-
174157
## `--max-input-size`
175158

176159
Sets the byte-size cap for any input file read by

0 commit comments

Comments
 (0)