docs: Adding meta data

.wordlist.txt

@@ -544,6 +544,7 @@ hipsparse
 hpp
 hsa
 hsakmt
+html
 hyperparameter
 ib_core
 inband
@@ -556,6 +557,7 @@ inlining
 installable
 instantiation
 interprocedural
+intersphinx
 intra
 invariants
 invocating
@@ -583,6 +585,7 @@ mkdir
 mlirmiopen
 mtypes
 mvffr
+myst
 namespace
 namespaces
 natively

docs/developer_guide/commitizen.md

@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "Commitizen enforces conventional commits and implements automatic release tagging based on commit messages."
+        "keywords": "Commit on ROCm docs core , Conventional commit on ROCm docs core, Commit messages on ROCm docs core, Commit using Commitizen, Commitizen, ROCm docs core developer guide"
+---
+
 # Commitizen
 
 The ROCm Docs Core repository uses

docs/developer_guide/dependabot.md

@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "Dependabot is automated dependency management tool"
+        "keywords": "Automated dependency management tool, Dependency management for ROCm documentation, Dependabot, ROCm docs core developer guide"
+---
+
 # Dependabot
 
 Dependabot is automated dependency management tool.

docs/developer_guide/developer_guide.md

@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "A collection of utilities, styling, scripts, and additional HTML content common to all ROCm projects’ documentation"
+        "keywords": "Processes in ROCm docs core, Toolchains in ROCm docs core, ROCm docs core developer guide"
+---
+
 # Developer Guide
 
 The Developer Guide provides additional information on the processes and toolchains in `rocm-docs-core`

docs/developer_guide/just.md

@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "Just is a command runner used to quickly setup an environment for documentation development"
+        "keywords": "Development environment for ROCm docs core, Environment for documentation development, Development environment for ROCm documentation, Just, ROCm docs core developer guide"
+---
+
 # Just
 
 [`just`](https://github.com/casey/just) is a command runner used to

docs/developer_guide/projects_yaml.md

@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "Defining external intersphinx project mapping"
+        "keywords": "External intersphinx project mapping, Project mapping in ROCm docs core, ROCm docs core developer guide"
+---
+
 # External Intersphinx Project Mapping
 
 Projects should be defined in `projects.yaml` and should set which key they correspond to by setting external_projects_current_project to this key.

docs/developer_guide/python_linting.md

@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "Tools used for checking correctness in Python code"
+        "keywords": "Python linting tool, Check correctness in Python code, ROCm docs core developer guide"
+---
+
 # Python Linting
 
 The following list of tools is used for checking correctness in Python code.

docs/index.md

@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "A collection of utilities, styling, scripts, and additional HTML content common to all ROCm projects’ documentation"
+        "keywords": "ROCm documentation configuration, ROCm documentation customization, ROCm documentation tool, ROCm docs core developer guide"
+---
+
 # ROCm Docs Core
 
 ROCm Docs Core is a collection of utilities, styling, scripts and additional

docs/user_guide/article_info.md

@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "Setting article info in ROCm documentation"
+        "keywords": "Configuring ROCm documentation, Article info, ROCm docs core user guide"
+---
+
 # Article Info
 
 Article info is disabled by default and must be enabled in `conf.py`.

docs/user_guide/linking_md.md

@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "Setting up links in Markdown to other projects, current project and external sites in ROCm documentation"
+        "keywords": "Markdown links in ROCm documentation, Project linking, Project reference, Adding links in Markdown, ROCm docs core user guide"
+---
+
 # Linking in Markdown
 
 ## Markdown

docs/user_guide/linking_rst.rst

@@ -1,3 +1,8 @@
+.. meta::
+   :description: Setting up links in RST to other projects, current project and external sites in ROCm documentation
+   :keywords: RST links in ROCm documentation, Project linking, Project reference, Adding links in RST, ROCm docs core user guide
+
+
 Linking in RST
 ==============
 

docs/user_guide/linking_toc.md

@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "Setting up links in the Table of Contents for ROCm documentation"
+        "keywords": "Links in TOC, Links in table of content, ROCm documentation TOC, ROCm documentation table of content, ROCm docs core user guide"
+---
+
 # Linking in the Table of Contents
 
 ## Syntax

docs/user_guide/spellcheck.md

@@ -1,3 +1,10 @@
+---
+myst:
+    html_meta:
+        "description": "Rocm docs core has spell checks run on every pull request"
+        "keywords": "Spell check in ROCm documentation, Spell check in ROCm docs core, ROCm docs core user guide"
+---
+
 # Spell Check
 
 `rocm-docs-core` has spell checks run on every pull request (PR) via GitHub Actions.