A group of documentation and CI polish items, grouped because they all sit in the docs tooling and mkdocs.yml.
CI lint failures
The validate stage has two failing lint jobs. Both are allow_failure, so the pipeline reports green while they fail.
- cspell: two words are missing from the project dictionary,
webforms(the plural form;webformis already allowed) andWSOD. Add both to.cspell-project-words.txt. - ESLint:
mkdocs.ymlraises twoyml/indenterrors. The nav entries under "Cross-site API" are indented four spaces and should be six.
Documentation site theme
The documentation currently renders with the default readthedocs theme. Switch mkdocs to the Material theme (mkdocs-material) for a clearer, searchable docs site, and make sure the documentation build installs mkdocs-material.
Logo and favicon
Add a project logo and a favicon for the docs site (the Material theme logo and favicon options), with the image assets stored under the docs directory.
Proposed resolution
- Add
webformsandWSODto the cspell dictionary. - Set the Material theme in
mkdocs.yml(which also corrects the nav indentation) and ensure the build installs mkdocs-material. - Add logo and favicon assets and reference them from
mkdocs.yml.
Issue fork pdv-3593440
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
Comments
Comment #4
mably commented