From fead301a4f51041651e4eb3b9960715d395c7547 Mon Sep 17 00:00:00 2001 From: Jorge <62282406+jorge-campo@users.noreply.github.com> Date: Tue, 30 Sep 2025 11:49:26 +0200 Subject: [PATCH 1/2] (#57) add files and folders scaffolding --- docs/README.md | 0 docs/codex/README.md | 0 docs/nomos/README.md | 0 docs/waku/README.md | 0 manual/0-overview/README.md | 0 manual/1-design-the-information/README.md | 0 manual/2-populate-the-structure/README.md | 0 manual/2-populate-the-structure/llm/README.md | 0 manual/3-validate-the-design/README.md | 0 manual/3-validate-the-design/linters/README.md | 0 manual/3-validate-the-design/self-review/README.md | 0 manual/3-validate-the-design/sme-review/README.md | 0 manual/3-validate-the-design/writing-rules/README.md | 0 manual/4-integrate-the-content/README.md | 0 manual/4-integrate-the-content/build-and-publish/README.md | 0 manual/4-integrate-the-content/content-model/README.md | 0 manual/README.md | 0 17 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/README.md create mode 100644 docs/codex/README.md create mode 100644 docs/nomos/README.md create mode 100644 docs/waku/README.md create mode 100644 manual/0-overview/README.md create mode 100644 manual/1-design-the-information/README.md create mode 100644 manual/2-populate-the-structure/README.md create mode 100644 manual/2-populate-the-structure/llm/README.md create mode 100644 manual/3-validate-the-design/README.md create mode 100644 manual/3-validate-the-design/linters/README.md create mode 100644 manual/3-validate-the-design/self-review/README.md create mode 100644 manual/3-validate-the-design/sme-review/README.md create mode 100644 manual/3-validate-the-design/writing-rules/README.md create mode 100644 manual/4-integrate-the-content/README.md create mode 100644 manual/4-integrate-the-content/build-and-publish/README.md create mode 100644 manual/4-integrate-the-content/content-model/README.md create mode 100644 manual/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/codex/README.md b/docs/codex/README.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/nomos/README.md b/docs/nomos/README.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/waku/README.md b/docs/waku/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/0-overview/README.md b/manual/0-overview/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/1-design-the-information/README.md b/manual/1-design-the-information/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/2-populate-the-structure/README.md b/manual/2-populate-the-structure/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/2-populate-the-structure/llm/README.md b/manual/2-populate-the-structure/llm/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/3-validate-the-design/README.md b/manual/3-validate-the-design/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/3-validate-the-design/linters/README.md b/manual/3-validate-the-design/linters/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/3-validate-the-design/self-review/README.md b/manual/3-validate-the-design/self-review/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/3-validate-the-design/sme-review/README.md b/manual/3-validate-the-design/sme-review/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/3-validate-the-design/writing-rules/README.md b/manual/3-validate-the-design/writing-rules/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/4-integrate-the-content/README.md b/manual/4-integrate-the-content/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/4-integrate-the-content/build-and-publish/README.md b/manual/4-integrate-the-content/build-and-publish/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/4-integrate-the-content/content-model/README.md b/manual/4-integrate-the-content/content-model/README.md new file mode 100644 index 0000000..e69de29 diff --git a/manual/README.md b/manual/README.md new file mode 100644 index 0000000..e69de29 From 4447b2f6b3b7ac31012e875d8bf4c6980be915c6 Mon Sep 17 00:00:00 2001 From: Jorge <62282406+jorge-campo@users.noreply.github.com> Date: Tue, 30 Sep 2025 14:51:08 +0200 Subject: [PATCH 2/2] (#57) move existing files and folders -- DON'T MERGE YET --- docs-standards/40-terminology/_index.md | 0 .../1-design-the-information/document-types}/api-quickstart.md | 0 .../document-types}/concept-help-me-to-understand.md | 0 .../1-design-the-information/document-types}/hybrid-topic.md | 0 .../document-types}/procedure-help-me-to-do.md | 0 .../document-types}/quickstart-help-me-get-started.md | 0 .../document-types}/reference-help-me-to-remember.md | 0 .../1-design-the-information/document-types}/troubleshooting.md | 0 .../canonical-examples}/concept-example.md | 0 .../2-populate-the-structure/templates}/concept-template.md | 0 .../2-populate-the-structure/templates}/reference-template.md | 0 .../2-populate-the-structure/templates}/template-quickstart.md | 0 .../writing-rules/structure-the-content/README.md | 0 .../writing-rules/style-the-content/README.md | 0 .../writing-rules/style-the-content/admonitions.md | 0 .../writing-rules/style-the-content/bullet-lists.md | 0 .../writing-rules/style-the-content/capitalization.md | 0 .../writing-rules/style-the-content/code.md | 0 .../writing-rules/style-the-content/links.md | 0 .../writing-rules/style-the-content/numbered-lists.md | 0 .../writing-rules/style-the-content/punctuation-and-symbols.md | 0 .../writing-rules/style-the-content/sentences-and-paragraphs.md | 0 .../writing-rules/style-the-content/tables.md | 0 .../writing-rules/style-the-content/titles.md | 0 .../writing-rules/style-the-content/ui-elements.md | 0 .../writing-rules/style-the-content/units-of-measure.md | 0 .../writing-rules/style-the-content/voice.md | 0 .../3-validate-the-design/writing-rules/terminology/README.md | 0 .../writing-rules/terminology/codex-terminology.md | 0 .../writing-rules/terminology/common-terminology.md | 0 .../writing-rules/terminology/nomos-terminology.md | 0 .../writing-rules/terminology/waku-terminology.md | 0 .../writing-rules/work-with-media/README.md | 0 .../writing-rules/work-with-media/diagrams.md | 0 .../writing-rules/work-with-media/icons-and-emojis.md | 0 .../writing-rules/work-with-media/images.md | 0 .../writing-rules/work-with-media/videos.md | 0 templates/concept/concept-example.md | 1 - 38 files changed, 1 deletion(-) delete mode 100644 docs-standards/40-terminology/_index.md rename {docs-standards/10-structure-the-content/01-document-types => manual/1-design-the-information/document-types}/api-quickstart.md (100%) rename {docs-standards/10-structure-the-content/01-document-types => manual/1-design-the-information/document-types}/concept-help-me-to-understand.md (100%) rename {docs-standards/10-structure-the-content/01-document-types => manual/1-design-the-information/document-types}/hybrid-topic.md (100%) rename {docs-standards/10-structure-the-content/01-document-types => manual/1-design-the-information/document-types}/procedure-help-me-to-do.md (100%) rename {docs-standards/10-structure-the-content/01-document-types => manual/1-design-the-information/document-types}/quickstart-help-me-get-started.md (100%) rename {docs-standards/10-structure-the-content/01-document-types => manual/1-design-the-information/document-types}/reference-help-me-to-remember.md (100%) rename {docs-standards/10-structure-the-content/01-document-types => manual/1-design-the-information/document-types}/troubleshooting.md (100%) rename {examples => manual/2-populate-the-structure/canonical-examples}/concept-example.md (100%) rename {templates/concept => manual/2-populate-the-structure/templates}/concept-template.md (100%) rename {templates/concept => manual/2-populate-the-structure/templates}/reference-template.md (100%) rename {templates/quickstart => manual/2-populate-the-structure/templates}/template-quickstart.md (100%) rename docs-standards/00-quickstart.md => manual/3-validate-the-design/writing-rules/structure-the-content/README.md (100%) rename docs-standards/01-general-guidelines.md => manual/3-validate-the-design/writing-rules/style-the-content/README.md (100%) rename docs-standards/10-structure-the-content/_index.md => manual/3-validate-the-design/writing-rules/style-the-content/admonitions.md (100%) rename docs-standards/20-style-the-content/01-voice.md => manual/3-validate-the-design/writing-rules/style-the-content/bullet-lists.md (100%) rename docs-standards/20-style-the-content/02-capitalization.md => manual/3-validate-the-design/writing-rules/style-the-content/capitalization.md (100%) rename docs-standards/20-style-the-content/13-code.md => manual/3-validate-the-design/writing-rules/style-the-content/code.md (100%) rename docs-standards/20-style-the-content/03-titles.md => manual/3-validate-the-design/writing-rules/style-the-content/links.md (100%) rename docs-standards/20-style-the-content/04-sentences-and-paragraphs.md => manual/3-validate-the-design/writing-rules/style-the-content/numbered-lists.md (100%) rename docs-standards/20-style-the-content/05-punctuation-and-symbols.md => manual/3-validate-the-design/writing-rules/style-the-content/punctuation-and-symbols.md (100%) rename docs-standards/20-style-the-content/06-bullet-lists.md => manual/3-validate-the-design/writing-rules/style-the-content/sentences-and-paragraphs.md (100%) rename docs-standards/20-style-the-content/07-numbered-lists.md => manual/3-validate-the-design/writing-rules/style-the-content/tables.md (100%) rename docs-standards/20-style-the-content/08-tables.md => manual/3-validate-the-design/writing-rules/style-the-content/titles.md (100%) rename docs-standards/20-style-the-content/09-units-of-measure.md => manual/3-validate-the-design/writing-rules/style-the-content/ui-elements.md (100%) rename docs-standards/20-style-the-content/10-links.md => manual/3-validate-the-design/writing-rules/style-the-content/units-of-measure.md (100%) rename docs-standards/20-style-the-content/11-ui-elements.md => manual/3-validate-the-design/writing-rules/style-the-content/voice.md (100%) rename docs-standards/20-style-the-content/12-admonitions.md => manual/3-validate-the-design/writing-rules/terminology/README.md (100%) rename docs-standards/20-style-the-content/_index.md => manual/3-validate-the-design/writing-rules/terminology/codex-terminology.md (100%) rename docs-standards/30-work-with-media/01-icons and emojis.md => manual/3-validate-the-design/writing-rules/terminology/common-terminology.md (100%) rename docs-standards/30-work-with-media/02-images.md => manual/3-validate-the-design/writing-rules/terminology/nomos-terminology.md (100%) rename docs-standards/30-work-with-media/03-diagrams.md => manual/3-validate-the-design/writing-rules/terminology/waku-terminology.md (100%) rename docs-standards/30-work-with-media/04-videos.md => manual/3-validate-the-design/writing-rules/work-with-media/README.md (100%) rename docs-standards/30-work-with-media/_index.md => manual/3-validate-the-design/writing-rules/work-with-media/diagrams.md (100%) rename docs-standards/40-terminology/01-common.md => manual/3-validate-the-design/writing-rules/work-with-media/icons-and-emojis.md (100%) rename docs-standards/40-terminology/02-waku.md => manual/3-validate-the-design/writing-rules/work-with-media/images.md (100%) rename docs-standards/40-terminology/03-codex.md => manual/3-validate-the-design/writing-rules/work-with-media/videos.md (100%) delete mode 100644 templates/concept/concept-example.md diff --git a/docs-standards/40-terminology/_index.md b/docs-standards/40-terminology/_index.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs-standards/10-structure-the-content/01-document-types/api-quickstart.md b/manual/1-design-the-information/document-types/api-quickstart.md similarity index 100% rename from docs-standards/10-structure-the-content/01-document-types/api-quickstart.md rename to manual/1-design-the-information/document-types/api-quickstart.md diff --git a/docs-standards/10-structure-the-content/01-document-types/concept-help-me-to-understand.md b/manual/1-design-the-information/document-types/concept-help-me-to-understand.md similarity index 100% rename from docs-standards/10-structure-the-content/01-document-types/concept-help-me-to-understand.md rename to manual/1-design-the-information/document-types/concept-help-me-to-understand.md diff --git a/docs-standards/10-structure-the-content/01-document-types/hybrid-topic.md b/manual/1-design-the-information/document-types/hybrid-topic.md similarity index 100% rename from docs-standards/10-structure-the-content/01-document-types/hybrid-topic.md rename to manual/1-design-the-information/document-types/hybrid-topic.md diff --git a/docs-standards/10-structure-the-content/01-document-types/procedure-help-me-to-do.md b/manual/1-design-the-information/document-types/procedure-help-me-to-do.md similarity index 100% rename from docs-standards/10-structure-the-content/01-document-types/procedure-help-me-to-do.md rename to manual/1-design-the-information/document-types/procedure-help-me-to-do.md diff --git a/docs-standards/10-structure-the-content/01-document-types/quickstart-help-me-get-started.md b/manual/1-design-the-information/document-types/quickstart-help-me-get-started.md similarity index 100% rename from docs-standards/10-structure-the-content/01-document-types/quickstart-help-me-get-started.md rename to manual/1-design-the-information/document-types/quickstart-help-me-get-started.md diff --git a/docs-standards/10-structure-the-content/01-document-types/reference-help-me-to-remember.md b/manual/1-design-the-information/document-types/reference-help-me-to-remember.md similarity index 100% rename from docs-standards/10-structure-the-content/01-document-types/reference-help-me-to-remember.md rename to manual/1-design-the-information/document-types/reference-help-me-to-remember.md diff --git a/docs-standards/10-structure-the-content/01-document-types/troubleshooting.md b/manual/1-design-the-information/document-types/troubleshooting.md similarity index 100% rename from docs-standards/10-structure-the-content/01-document-types/troubleshooting.md rename to manual/1-design-the-information/document-types/troubleshooting.md diff --git a/examples/concept-example.md b/manual/2-populate-the-structure/canonical-examples/concept-example.md similarity index 100% rename from examples/concept-example.md rename to manual/2-populate-the-structure/canonical-examples/concept-example.md diff --git a/templates/concept/concept-template.md b/manual/2-populate-the-structure/templates/concept-template.md similarity index 100% rename from templates/concept/concept-template.md rename to manual/2-populate-the-structure/templates/concept-template.md diff --git a/templates/concept/reference-template.md b/manual/2-populate-the-structure/templates/reference-template.md similarity index 100% rename from templates/concept/reference-template.md rename to manual/2-populate-the-structure/templates/reference-template.md diff --git a/templates/quickstart/template-quickstart.md b/manual/2-populate-the-structure/templates/template-quickstart.md similarity index 100% rename from templates/quickstart/template-quickstart.md rename to manual/2-populate-the-structure/templates/template-quickstart.md diff --git a/docs-standards/00-quickstart.md b/manual/3-validate-the-design/writing-rules/structure-the-content/README.md similarity index 100% rename from docs-standards/00-quickstart.md rename to manual/3-validate-the-design/writing-rules/structure-the-content/README.md diff --git a/docs-standards/01-general-guidelines.md b/manual/3-validate-the-design/writing-rules/style-the-content/README.md similarity index 100% rename from docs-standards/01-general-guidelines.md rename to manual/3-validate-the-design/writing-rules/style-the-content/README.md diff --git a/docs-standards/10-structure-the-content/_index.md b/manual/3-validate-the-design/writing-rules/style-the-content/admonitions.md similarity index 100% rename from docs-standards/10-structure-the-content/_index.md rename to manual/3-validate-the-design/writing-rules/style-the-content/admonitions.md diff --git a/docs-standards/20-style-the-content/01-voice.md b/manual/3-validate-the-design/writing-rules/style-the-content/bullet-lists.md similarity index 100% rename from docs-standards/20-style-the-content/01-voice.md rename to manual/3-validate-the-design/writing-rules/style-the-content/bullet-lists.md diff --git a/docs-standards/20-style-the-content/02-capitalization.md b/manual/3-validate-the-design/writing-rules/style-the-content/capitalization.md similarity index 100% rename from docs-standards/20-style-the-content/02-capitalization.md rename to manual/3-validate-the-design/writing-rules/style-the-content/capitalization.md diff --git a/docs-standards/20-style-the-content/13-code.md b/manual/3-validate-the-design/writing-rules/style-the-content/code.md similarity index 100% rename from docs-standards/20-style-the-content/13-code.md rename to manual/3-validate-the-design/writing-rules/style-the-content/code.md diff --git a/docs-standards/20-style-the-content/03-titles.md b/manual/3-validate-the-design/writing-rules/style-the-content/links.md similarity index 100% rename from docs-standards/20-style-the-content/03-titles.md rename to manual/3-validate-the-design/writing-rules/style-the-content/links.md diff --git a/docs-standards/20-style-the-content/04-sentences-and-paragraphs.md b/manual/3-validate-the-design/writing-rules/style-the-content/numbered-lists.md similarity index 100% rename from docs-standards/20-style-the-content/04-sentences-and-paragraphs.md rename to manual/3-validate-the-design/writing-rules/style-the-content/numbered-lists.md diff --git a/docs-standards/20-style-the-content/05-punctuation-and-symbols.md b/manual/3-validate-the-design/writing-rules/style-the-content/punctuation-and-symbols.md similarity index 100% rename from docs-standards/20-style-the-content/05-punctuation-and-symbols.md rename to manual/3-validate-the-design/writing-rules/style-the-content/punctuation-and-symbols.md diff --git a/docs-standards/20-style-the-content/06-bullet-lists.md b/manual/3-validate-the-design/writing-rules/style-the-content/sentences-and-paragraphs.md similarity index 100% rename from docs-standards/20-style-the-content/06-bullet-lists.md rename to manual/3-validate-the-design/writing-rules/style-the-content/sentences-and-paragraphs.md diff --git a/docs-standards/20-style-the-content/07-numbered-lists.md b/manual/3-validate-the-design/writing-rules/style-the-content/tables.md similarity index 100% rename from docs-standards/20-style-the-content/07-numbered-lists.md rename to manual/3-validate-the-design/writing-rules/style-the-content/tables.md diff --git a/docs-standards/20-style-the-content/08-tables.md b/manual/3-validate-the-design/writing-rules/style-the-content/titles.md similarity index 100% rename from docs-standards/20-style-the-content/08-tables.md rename to manual/3-validate-the-design/writing-rules/style-the-content/titles.md diff --git a/docs-standards/20-style-the-content/09-units-of-measure.md b/manual/3-validate-the-design/writing-rules/style-the-content/ui-elements.md similarity index 100% rename from docs-standards/20-style-the-content/09-units-of-measure.md rename to manual/3-validate-the-design/writing-rules/style-the-content/ui-elements.md diff --git a/docs-standards/20-style-the-content/10-links.md b/manual/3-validate-the-design/writing-rules/style-the-content/units-of-measure.md similarity index 100% rename from docs-standards/20-style-the-content/10-links.md rename to manual/3-validate-the-design/writing-rules/style-the-content/units-of-measure.md diff --git a/docs-standards/20-style-the-content/11-ui-elements.md b/manual/3-validate-the-design/writing-rules/style-the-content/voice.md similarity index 100% rename from docs-standards/20-style-the-content/11-ui-elements.md rename to manual/3-validate-the-design/writing-rules/style-the-content/voice.md diff --git a/docs-standards/20-style-the-content/12-admonitions.md b/manual/3-validate-the-design/writing-rules/terminology/README.md similarity index 100% rename from docs-standards/20-style-the-content/12-admonitions.md rename to manual/3-validate-the-design/writing-rules/terminology/README.md diff --git a/docs-standards/20-style-the-content/_index.md b/manual/3-validate-the-design/writing-rules/terminology/codex-terminology.md similarity index 100% rename from docs-standards/20-style-the-content/_index.md rename to manual/3-validate-the-design/writing-rules/terminology/codex-terminology.md diff --git a/docs-standards/30-work-with-media/01-icons and emojis.md b/manual/3-validate-the-design/writing-rules/terminology/common-terminology.md similarity index 100% rename from docs-standards/30-work-with-media/01-icons and emojis.md rename to manual/3-validate-the-design/writing-rules/terminology/common-terminology.md diff --git a/docs-standards/30-work-with-media/02-images.md b/manual/3-validate-the-design/writing-rules/terminology/nomos-terminology.md similarity index 100% rename from docs-standards/30-work-with-media/02-images.md rename to manual/3-validate-the-design/writing-rules/terminology/nomos-terminology.md diff --git a/docs-standards/30-work-with-media/03-diagrams.md b/manual/3-validate-the-design/writing-rules/terminology/waku-terminology.md similarity index 100% rename from docs-standards/30-work-with-media/03-diagrams.md rename to manual/3-validate-the-design/writing-rules/terminology/waku-terminology.md diff --git a/docs-standards/30-work-with-media/04-videos.md b/manual/3-validate-the-design/writing-rules/work-with-media/README.md similarity index 100% rename from docs-standards/30-work-with-media/04-videos.md rename to manual/3-validate-the-design/writing-rules/work-with-media/README.md diff --git a/docs-standards/30-work-with-media/_index.md b/manual/3-validate-the-design/writing-rules/work-with-media/diagrams.md similarity index 100% rename from docs-standards/30-work-with-media/_index.md rename to manual/3-validate-the-design/writing-rules/work-with-media/diagrams.md diff --git a/docs-standards/40-terminology/01-common.md b/manual/3-validate-the-design/writing-rules/work-with-media/icons-and-emojis.md similarity index 100% rename from docs-standards/40-terminology/01-common.md rename to manual/3-validate-the-design/writing-rules/work-with-media/icons-and-emojis.md diff --git a/docs-standards/40-terminology/02-waku.md b/manual/3-validate-the-design/writing-rules/work-with-media/images.md similarity index 100% rename from docs-standards/40-terminology/02-waku.md rename to manual/3-validate-the-design/writing-rules/work-with-media/images.md diff --git a/docs-standards/40-terminology/03-codex.md b/manual/3-validate-the-design/writing-rules/work-with-media/videos.md similarity index 100% rename from docs-standards/40-terminology/03-codex.md rename to manual/3-validate-the-design/writing-rules/work-with-media/videos.md diff --git a/templates/concept/concept-example.md b/templates/concept/concept-example.md deleted file mode 100644 index dcdbcf7..0000000 --- a/templates/concept/concept-example.md +++ /dev/null @@ -1 +0,0 @@ -# Concept example