Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorLeitwolf112026-11-15 15:28:42 +0300
committerLeitwolf112026-11-15 15:28:42 +0300
commitba19afa4f94e8b0ef8a66b4e12fcdd92803ab821 (patch)
treeac0284354ed3e603a415362f50dbd3c337b60a25
parentca0f0ffc0dadc7a3fd6476606c99adb2b4c654c6 (diff)
downloadprogmasoft-cpp-docs/index-schema.tar.gz
Name the JSON Schema of index.jsondocs/index-schema
index.json points to https://schemastore.progmasoft.com/json/progmasoft-cpp-index.json in $schema, so editors check it: the versions with exactly one default, and every document with its chapter, path and versions. The README and the changelog link the schema. The file validates against it. Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01Ji7xZMYjc4zankoc7hGBE1
-rw-r--r--CHANGELOG.md4
-rw-r--r--Progmasoft_Core_Cpp_Coding_Guidelines/index.json1
-rw-r--r--README.md3
3 files changed, 7 insertions, 1 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b220345..8fb3c39 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,10 @@ A revision of Progmasoft C/C++ Styles is named by its date. A change that requir
## Unreleased
+`index.json` names its JSON Schema,
+[schemastore.progmasoft.com/json/progmasoft-cpp-index.json](https://schemastore.progmasoft.com/json/progmasoft-cpp-index.json),
+in `$schema`; editors check the file against it.
+
`Progmasoft_Chene_Cpp_Coding_Guidelines/` (C++20, not written yet) takes the place of the former C++17 component
guidelines folder.
diff --git a/Progmasoft_Core_Cpp_Coding_Guidelines/index.json b/Progmasoft_Core_Cpp_Coding_Guidelines/index.json
index 7bb0c28..9de7bc4 100644
--- a/Progmasoft_Core_Cpp_Coding_Guidelines/index.json
+++ b/Progmasoft_Core_Cpp_Coding_Guidelines/index.json
@@ -1,4 +1,5 @@
{
+ "$schema": "https://schemastore.progmasoft.com/json/progmasoft-cpp-index.json",
"title": "Progmasoft Core C++ Coding Guidelines",
"license": "CC-BY-4.0",
"standards": [
diff --git a/README.md b/README.md
index c9a7a66..437e9dd 100644
--- a/README.md
+++ b/README.md
@@ -57,7 +57,8 @@ Each version has a page of its own with the rules that use its features:
The guidelines are in `Progmasoft_Core_Cpp_Coding_Guidelines/`: `Common/` holds what applies to both versions, `Cpp20/`
and `Cpp17/` what applies to one. [`index.json`](Progmasoft_Core_Cpp_Coding_Guidelines/index.json) lists every document
-with its chapter and the versions it applies to, for tools that show or check the guidelines.
+with its chapter and the versions it applies to, for tools that show or check the guidelines; its schema is
+[schemastore.progmasoft.com/json/progmasoft-cpp-index.json](https://schemastore.progmasoft.com/json/progmasoft-cpp-index.json).
[Adopting the guidelines](ADOPTING.md) explains how a project points to them, which files it copies and how it
records a deviation. [Contributing](CONTRIBUTING.md) explains how to propose a change to a rule.