diff --git a/.copier-answers.yml b/.copier-answers.yml index 879d4cb13..d7c4e0089 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,5 +1,5 @@ # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY -_commit: 5875bae +_commit: d2d1381 _src_path: gh:canonical/platform-engineering-documentation-files.git author: Canonical Ltd. discourse: https://discourse.charmhub.io diff --git a/docs/conf.py b/docs/conf.py index dd05adae6..262a1ce89 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -162,6 +162,11 @@ """ ) +# sphinx-markdown-builder (run by sphinx_llm.txt) has no visitor for these nodes. +# "meta" may be removable once liran-funaro/sphinx-markdown-builder#70 / NVIDIA/sphinx-llm#172 land; +# "mermaid" is unaddressed upstream and will still need suppressing. +llms_txt_suppress_unknown_node_warnings = ["meta", "mermaid"] + # The base URL for references built by sphinx-markdown-builder. if os.environ.get("READTHEDOCS"): markdown_http_base = html_baseurl diff --git a/docs/how-to/contribute.rst b/docs/how-to/contribute.rst index c064a4bf1..c0b38cdbe 100644 --- a/docs/how-to/contribute.rst +++ b/docs/how-to/contribute.rst @@ -34,7 +34,7 @@ The purpose of these issues is to provide newcomers with opportunities to contribute to our projects and gain documentation skills. Using AI to complete these tasks undermines their purpose. -If you use AI to help with your PRs, be mindful. Avoid submitting contributions +If you use AI to help with your pull requests, be mindful. Avoid submitting contributions with entirely AI-generated documentation. The human aspect of documentation is important to us, and that includes tone, syntax, perspectives, and the occasional typo. diff --git a/docs/release-notes/template/_release-artifact-template.yaml b/docs/release-notes/template/_release-artifact-template.yaml index 33339f32f..bc2710108 100644 --- a/docs/release-notes/template/_release-artifact-template.yaml +++ b/docs/release-notes/template/_release-artifact-template.yaml @@ -1,17 +1,13 @@ # --- Information about release ---- -version_schema: 2 +version_schema: 3 +workload_with_version:: -# name of workload and version in the release -workload_with_version: +# Rows of the requirements table, for example "3.6", "MicroK8s 1.36", "24.04". +juju_version: +kubernetes_version: +ubuntu_version: -# list of change artifacts included in the release included_changes: - -# earliest revision included in the release earliest_revision: - -# latest revision included in the release latest_revision: - - diff --git a/docs/requirements.txt b/docs/requirements.txt index 9a86663a2..448fbbe8b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -27,11 +27,11 @@ packaging==26.3 sphinxcontrib-svg2pdfconverter[CairoSVG]==2.1.0 sphinx-last-updated-by-git==0.3.8 sphinx-sitemap==2.9.0 -sphinx-llm==1.0.0 +sphinx-llm==1.1.0 # Mermaid diagrams sphinxcontrib-mermaid==2.1.1 # Vale dependencies rst2html==2020.7.4 -vale==3.20.0.0 +vale==3.22.0.0