Skip to content

Commit cf8088e

Browse files
docs: small docs change + bundled schema formatting script (modelcontextprotocol#1078)
Co-authored-by: David Soria Parra <[email protected]>
1 parent 40a639b commit cf8088e

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ npm run check:docs
7070
npm run format
7171
```
7272

73+
> [!NOTE]
74+
> You can run all schema/documentation
75+
> changes at once with `npm run prep:changes`.
76+
7377
## Blog changes
7478

7579
The blog is built using [Hugo](https://gohugo.io/installation/) and located in the [`blog`](./blog) directory.
@@ -80,7 +84,7 @@ To preview blog changes locally:
8084
npm run serve:blog
8185
```
8286

83-
## Documentation Guidelines
87+
### Documentation Guidelines
8488

8589
When contributing to the documentation:
8690

package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,18 @@
2222
},
2323
"scripts": {
2424
"check": "npm run check:schema && npm run check:docs",
25+
"check:docs": "npm run check:docs:format && npm run check:docs:links",
26+
"check:docs:format": "prettier --check \"**/*.{md,mdx}\"",
27+
"check:docs:links": "cd docs && npx mint broken-links",
2528
"check:schema": "npm run check:schema:ts && npm run check:schema:json && npm run check:schema:md",
2629
"check:schema:ts": "tsc --noEmit && eslint schema/ && prettier --check \"schema/**/*.ts\"",
2730
"check:schema:json": "tsx scripts/generate-schemas.ts --check",
2831
"check:schema:md": "for f in schema/*/schema.mdx; do typedoc --entryPoints \"${f%.mdx}.ts\" --schemaPageTemplate \"$f\" | cmp docs/specification/$(basename -- $(dirname -- \"$f\"))/schema.mdx - || exit 1; done",
29-
"check:docs": "npm run check:docs:format && npm run check:docs:links",
30-
"check:docs:format": "prettier --check \"**/*.{md,mdx}\"",
31-
"check:docs:links": "cd docs && npx mint broken-links",
32+
"format": "prettier --write \"**/*.{md,mdx}\" --ignore \"docs/specification/*/schema.mdx\" ",
3233
"generate:schema": "npm run generate:schema:json && npm run generate:schema:md",
3334
"generate:schema:json": "tsx scripts/generate-schemas.ts",
3435
"generate:schema:md": "for f in schema/*/schema.mdx; do typedoc --entryPoints \"${f%.mdx}.ts\" --schemaPageTemplate \"$f\" > docs/specification/$(basename -- $(dirname -- \"$f\"))/schema.mdx; done",
35-
"format": "prettier --write \"**/*.{md,mdx}\" --ignore \"docs/specification/*/schema.mdx\" ",
36+
"prep:changes": "npm run check:schema:ts && npm run generate:schema && npm run check:docs && npm run format",
3637
"serve:docs": "cd docs && npx mint dev",
3738
"serve:blog": "cd blog && hugo serve"
3839
},

0 commit comments

Comments
 (0)