From 8921602e9fba210c09424510a0d4f5efb298d373 Mon Sep 17 00:00:00 2001 From: David Biesack Date: Mon, 12 May 2025 17:27:19 -0400 Subject: [PATCH 1/2] Fix typos in CONTRIBUTING.md --- CONTRIBUTING.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3b6614769b..0ee028b343 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,8 +56,9 @@ Make a local clone of your fork and check out the Working in the `gh-pages` branch, add a new Markdown file in `registries/_namespace/`. The file name -should be the namespace name with a `.md` extension. For example, -to add an extension namespace `abc` for extensions named `x-abc-*`, +should be the namespace name with a `.md` extension, without the `x-` +prefix. +For example, to add an extension namespace `abc` for extensions named `x-abc-*`, create `registries/_namespace/abc.md`. Use the following template, replacing the instruction text in `<>` markers: @@ -89,13 +90,13 @@ the site as described above and view [http://127.0.0.1:4000/registry/namespace/index.html](http://127.0.0.1:4000/registry/namespace/index.html) to verify your namespace is listed. (Modify the URL if Jekyll is running on a different IP or port.) -The namespace name in Value column +The namespace name in __Value__ column should link to your namespace page, and the __Description__ text should be the `description:` from the Markdown frontmatter. Preview your content at `http://127.0.0.1:4000/registry/namespace/abc.html` -(change `abc` in to your namespace URL). +(change `abc` in to your namespace name in the URL). ### Add a New Specification Extension Registry Entry @@ -147,9 +148,9 @@ Build the site locally as described above. Preview [http://127.0.0.1:4000/registry/extension/](http://127.0.0.1:4000/registry/extension/). (Modify the URL if Jekyll is running on a different IP or port.) -Verify that you specification extension -should is listed. The __Value__ column should contain you extension name -with a link to you documentation, such as +Verify that your specification extension +is listed. The __Value__ column should contain your extension name +with a link to your documentation, such as `http://127.0.0.1:4000/registry/extension/x-abc-wander.html`, and the __Description__ should be your brief description. From 80c16a63fe05dfd55de29c886e3bf8694347c286 Mon Sep 17 00:00:00 2001 From: David Biesack Date: Mon, 12 May 2025 17:28:55 -0400 Subject: [PATCH 2/2] Fix typos in CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0ee028b343..7b143301d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,7 +96,7 @@ text should be the `description:` from the Markdown frontmatter. Preview your content at `http://127.0.0.1:4000/registry/namespace/abc.html` -(change `abc` in to your namespace name in the URL). +(change `abc` to your namespace name in the URL). ### Add a New Specification Extension Registry Entry