Skip to content

Commit 1cbbbd7

Browse files
committed
Add meta tag description for most pages
1 parent d775b4f commit 1cbbbd7

10 files changed

Lines changed: 52 additions & 0 deletions

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
html_static_path = ['_static']
3636
html_favicon = '_static/favicon_32.png'
3737
html_last_updated_fmt = '%Y-%m-%d'
38+
html_extra_path = ['_extra'] # files to copy to output root
3839

3940
# -- Options for todo extension -----------------------------------
4041
# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#module-sphinx.ext.todo

docs/docs_maintenance/creating-docs-locally.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description lang=en": "Build docs locally with Python/uv, install requirements, run sphinx-build, and preview vocabulary HTML. Learn more here."
5+
---
6+
17
# Building the docs locally
28

39
You need on your computer:

docs/docs_maintenance/handling-ID-requests.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description lang=en": "Maintainer steps to update vocabulary ID ranges: pull main, edit idranges.toml, commit, push, open PR, and clean up branches. Learn more here."
5+
---
6+
17
# Handling ID-requests
28

39
```{note} This guide is only relevant for maintainers with commit rights.

docs/docs_maintenance/making-releases.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description lang=en": "Release checklist for the vocabulary: prepare branch, update docs and metadata, tag vYYYY-MM-DD, monitor publish workflow, verify URLs. Learn more here."
5+
---
6+
17
# Making Releases
28

39
```{note} This guide is only relevant for maintainers with commit rights.

docs/docs_usage/about.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description lang=en": "Voc4Cat project context: community, curator governance, citations, licensing, and funding for the vocabulary and tools. Learn more here."
5+
---
6+
17
# About Voc4Cat
28

39
## Community

docs/docs_usage/guidelines.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description lang=en": "Editorial rules for Voc4Cat vocabulary and terminology: labels, definitions, spelling, grammar, typography, and SKOS mappings. Learn more here."
5+
---
6+
17
# Guidelines for Voc4Cat
28

39
The Voc4Cat guidelines have been developed as a blueprint for

docs/docs_usage/how-to-contribute.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description lang=en": "Contribution guide for the Voc4Cat vocabulary: Learn how to request IDs, edit voc4cat.xlsx, and submit a PR with Excel updates."
5+
---
6+
17
# How to contribute to Voc4Cat?
28

39
The contribution process is almost the same as in source code repositories.

docs/docs_usage/organizing-concepts.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description lang=en": "Learn how Voc4Cat is organised, from top concepts to its use of different hierarchy types like IS-A, HAS-A or PART-OF."
5+
---
6+
17
# Hierarchies, Relations, and Collections
28

39
## The Three Fundamental Semantic Relations

docs/docs_usage/published-guidelines.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description lang=en": "Citation details for published Voc4Cat vocabulary guidelines on Zenodo and the canonical online version. Learn more here."
5+
---
6+
17
# Published Voc4Cat Guidelines
28

39
````{admonition} Suggested citation for the most current version [published on Zenodo](https://doi.org/10.5281/zenodo.15006962)

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
---
22
hide-toc: true
3+
myst:
4+
html_meta:
5+
"description lang=en": "Voc4Cat vocabulary for catalysis: docs, releases, RDF downloads, and why curated terms support FAIR data. Learn more here."
36
---
47

58
# Welcome to Voc4Cat

0 commit comments

Comments
 (0)