docs/: add comment to md files declaring document mode

Open-Telecoms-Data · May 23, 2024 · 98919f0 · 98919f0
1 parent 41addf3
commit 98919f0
Show file tree

Hide file tree

Showing 20 changed files with 40 additions and 0 deletions.
diff --git a/docs/governance/index.md b/docs/governance/index.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # Governance
 
 ```{admonition} 0.3.0 release

diff --git a/docs/guidance/index.md b/docs/guidance/index.md
@@ -1,3 +1,5 @@
+<!-- docs-type: how-to-guides https://diataxis.fr/how-to-guides/ -->
+
 # Guidance
 
 ```{admonition} 0.3.0 release

diff --git a/docs/guidance/publication.md b/docs/guidance/publication.md
@@ -1,3 +1,5 @@
+<!-- docs-type: how-to-guides https://diataxis.fr/how-to-guides/ -->
+
 # How to publish OFDS data
 
 ```{admonition} 0.3.0 release

diff --git a/docs/guidance/use.md b/docs/guidance/use.md
@@ -1,3 +1,5 @@
+<!-- docs-type: how-to-guides https://diataxis.fr/how-to-guides/ -->
+
 # How to use OFDS data
 
 ```{admonition} 0.3.0 release

diff --git a/docs/history/changelog.md b/docs/history/changelog.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # Changelog
 
 ```{admonition} 0.3.0 release

diff --git a/docs/history/index.md b/docs/history/index.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # History
 
 ```{admonition} 0.3.0 release

diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,5 @@
+<!-- docs-type: explanation https://diataxis.fr/explanation/ -->
+
 # Open Fibre Data Standard
 
 ```{admonition} 0.3.0 release

diff --git a/docs/primer/index.md b/docs/primer/index.md
@@ -1,3 +1,5 @@
+<!-- docs-type: explanation https://diataxis.fr/explanation/ -->
+
 # Primer
 
 ```{admonition} 0.3.0 release

diff --git a/docs/primer/openfibredata.md b/docs/primer/openfibredata.md
@@ -1,3 +1,5 @@
+<!-- docs-type: explanation https://diataxis.fr/explanation/ -->
+
 # Open fibre data
 
 ```{admonition} 0.3.0 release

diff --git a/docs/primer/openfibredatastandard.md b/docs/primer/openfibredatastandard.md
@@ -1,3 +1,5 @@
+<!-- docs-type: explanation https://diataxis.fr/explanation/ -->
+
 # The Open Fibre Data Standard
 
 ```{admonition} 0.3.0 release

diff --git a/docs/primer/scopeandkeyconcepts.md b/docs/primer/scopeandkeyconcepts.md
@@ -1,3 +1,5 @@
+<!-- docs-type: explanation https://diataxis.fr/explanation/ -->
+
 # Scope and key concepts
 
 ```{admonition} 0.3.0 release

diff --git a/docs/reference/codelists.md b/docs/reference/codelists.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # Codelists reference
 
 ```{admonition} 0.3.0 release

diff --git a/docs/reference/identifiers.md b/docs/reference/identifiers.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # Identifiers
 
 ```{admonition} 0.3.0 release

diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # Reference
 
 ```{admonition} 0.3.0 release

diff --git a/docs/reference/publication_formats/csv.md b/docs/reference/publication_formats/csv.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # CSV
 
 ```{admonition} 0.3.0 release

diff --git a/docs/reference/publication_formats/geojson.md b/docs/reference/publication_formats/geojson.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # GeoJSON
 
 ```{admonition} 0.3.0 release

diff --git a/docs/reference/publication_formats/index.md b/docs/reference/publication_formats/index.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # Publication formats reference
 
 ```{admonition} 0.3.0 release

diff --git a/docs/reference/publication_formats/json.md b/docs/reference/publication_formats/json.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # JSON
 
 ```{admonition} 0.3.0 release

diff --git a/docs/reference/schema.md b/docs/reference/schema.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # Schema reference
 
 ```{admonition} 0.3.0 release

diff --git a/docs/support/index.md b/docs/support/index.md
@@ -1,3 +1,5 @@
+<!-- docs-type: reference https://diataxis.fr/reference/ -->
+
 # Getting Help
 
 ```{admonition} 0.3.0 release