Skip to content

Commit

Permalink
docs: Fixing metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
SwRaw committed Dec 19, 2024
1 parent 4e65d52 commit ef63203
Show file tree
Hide file tree
Showing 16 changed files with 106 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,7 @@ hipsparse
hpp
hsa
hsakmt
html
hyperparameter
ib_core
inband
Expand All @@ -556,6 +557,7 @@ inlining
installable
instantiation
interprocedural
intersphinx
intra
invariants
invocating
Expand Down Expand Up @@ -583,6 +585,7 @@ mkdir
mlirmiopen
mtypes
mvffr
myst
namespace
namespaces
natively
Expand Down
7 changes: 7 additions & 0 deletions docs/developer_guide/commitizen.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
myst:
html_meta:
"description": "Commitizen enforces conventional commits and implements automatic release tagging based on commit messages."
"keywords": "Commit, Conventional commit, Commit messages, Commit using Commitizen, Commitizen, Documentation configuration"
---

# Commitizen

The ROCm Docs Core repository uses
Expand Down
7 changes: 7 additions & 0 deletions docs/developer_guide/dependabot.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
myst:
html_meta:
"description": "Dependabot is automated dependency management tool"
"keywords": "Automated dependency management tool, Dependency management, Dependabot, Documentation dependencies"
---

# Dependabot

Dependabot is automated dependency management tool.
Expand Down
7 changes: 7 additions & 0 deletions docs/developer_guide/developer_guide.md
Original file line number Diff line number Diff line change
@@ -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": "Documentation processes, Documentation toolchains, Documentation configuration"
---

# Developer Guide

The Developer Guide provides additional information on the processes and toolchains in `rocm-docs-core`
7 changes: 7 additions & 0 deletions docs/developer_guide/just.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
myst:
html_meta:
"description": "Just is a command runner used to quickly setup an environment for documentation development"
"keywords": "Documentation development environment, Environment for documentation development, Just, Documentation configuration"
---

# Just

[`just`](https://github.com/casey/just) is a command runner used to
Expand Down
7 changes: 7 additions & 0 deletions docs/developer_guide/projects_yaml.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
myst:
html_meta:
"description": "Defining external intersphinx project mapping"
"keywords": "Intersphinx, project mapping, Documentation configuration"
---

# 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.
Expand Down
7 changes: 7 additions & 0 deletions docs/developer_guide/python_linting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
myst:
html_meta:
"description": "Tools used for checking correctness in Python code"
"keywords": "Python linting tool, Error checker, Documentation configuration"
---

# Python Linting

The following list of tools is used for checking correctness in Python code.
Expand Down
7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 7 additions & 0 deletions docs/user_guide/article_info.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
myst:
html_meta:
"description": "Setting article info in ROCm documentation"
"keywords": "Documentation settings, Display document information, Display article metadata, Display document metadata"
---

# Article Info

Article info is disabled by default and must be enabled in `conf.py`.
Expand Down
7 changes: 7 additions & 0 deletions docs/user_guide/linking.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
myst:
html_meta:
"description": "Setting up links to other projects, current project and external sites in ROCm documentation"
"keywords": "Adding links, Project linking, Project reference, Documentation settings"
---

# Linking

[Markdown](./linking_md)
Expand Down
7 changes: 7 additions & 0 deletions docs/user_guide/linking_md.md
Original file line number Diff line number Diff line change
@@ -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, Project linking, Project reference, Adding links in Markdown, Documentation settings"
---

# Linking in Markdown

## Markdown
Expand Down
5 changes: 5 additions & 0 deletions docs/user_guide/linking_rst.rst
Original file line number Diff line number Diff line change
@@ -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, Project linking, Project reference, Adding links in RST, Documentation settings


Linking in RST
==============

Expand Down
7 changes: 7 additions & 0 deletions docs/user_guide/linking_toc.md
Original file line number Diff line number Diff line change
@@ -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, Documentation TOC, Documentation table of content, Document index, Documentation settings"
---

# Linking in the Table of Contents

## Syntax
Expand Down
7 changes: 7 additions & 0 deletions docs/user_guide/linting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
myst:
html_meta:
"description": "Linting ensures correct Markdown and ReStructuredText formatting on every pull request"
"keywords": "Formatting PR, Formatting pull requests, Linting checks, Documentation settings"
---

# Linting

`rocm-docs-core` has linting to ensure correct Markdown and ReStructuredText
Expand Down
7 changes: 7 additions & 0 deletions docs/user_guide/spellcheck.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
7 changes: 7 additions & 0 deletions docs/user_guide/user_guide.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
myst:
html_meta:
"description": "The user guide describes how users can make use of functionalities in ROCm docs core"
"keywords": "ROCm docs core functionalities, Documentation settings"
---

# User Guide

The User Guide describes how users can make use of functionality in `rocm-docs-core`

0 comments on commit ef63203

Please sign in to comment.