Skip to content

Update the documentation to the current Plone docs standard - #44

Merged
ericof merged 2 commits into
mainfrom
issue-43
Oct 27, 2026
Merged

ericof merged 2 commits into
mainfrom
issue-43

Conversation

@ericof

@ericof ericof commented Oct 27, 2026

Copy link
Copy Markdown
Member

The documentation was scaffolded from an earlier version of the cookieplone-templates docs starter and had drifted from it. It still carried Read the Docs configuration with an unfilled MY_READTHEDOCS_PROJECT_SLUG placeholder, although the docs are built and published to GitHub Pages by docs-deploy.yml.

This PR brings the documentation up to the current standard:

  • Toolchain: docs/ follows the current docs starter (pyproject.toml, Makefile, conf.py, Vale configuration), and the docs build runs on Python 3.14 like the package.
  • Read the Docs removed: .readthedocs.yaml, the rtd-* Makefile targets, the README section and the CI path filter are gone. The OpenSearch, sitemap and robots.txt URLs now point to the GitHub Pages site.
  • Content: the pages were revised to the Plone documentation style. They are organized by Diátaxis section, follow Vale and use MyST markup, and they cover the HTML and Markdown input formats across the Python API, the CLI and the HTTP service.

The docs jobs in main.yml (docs and docs-deploy) now run on Python 3.14, while the other jobs keep the 3.12 default from config.yml. The theme repository links and the edit path in conf.py pointed at a wrong repository name, collectivehtml2blocksdocumentation; they now point at collective/collective.html2blocks. The CLI and HTTP service details moved from the how-to pages into new reference pages, and the how-to pages link to them.

Closes #43

The docs were scaffolded from an earlier cookieplone-templates docs starter
and carried Read the Docs configuration with an unfilled placeholder slug.

- Toolchain: align docs/pyproject.toml, docs/Makefile and docs/docs/conf.py
  with the current starter. Remove the rtd-* targets, the Read the Docs
  README section and docs/.readthedocs.yaml. Allow Python up to 3.14 for
  the docs project and regenerate docs/uv.lock.
- Point the OpenSearch, sitemap and robots.txt URLs at the GitHub Pages site.
  Fix the theme repository and edit URLs that pointed at a wrong repository name.
- Remove the Read the Docs path filter from the CI configuration.
- Revise the pages to the Plone documentation style and organize them by
  Diataxis section. Add a first-document tutorial, the how-to index, the
  reference index, and CLI and HTTP service reference pages. Document HTML
  and Markdown input for the Python API, the CLI and the HTTP service.
- Fix the glossary, the Vale vocabulary and the examples that did not run.

Refs #43
The docs and docs-deploy jobs in main.yml now pass python-version 3.14.
The other jobs keep the default from config.yml.

Refs #43
@ericof
ericof merged commit 900a5a2 into main Oct 27, 2026
14 checks passed
@ericof
ericof deleted the issue-43 branch October 27, 2026 04:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update the documentation to the current Plone docs standard and drop Read the Docs

1 participant