canonical / canonical/documentation-workflows

Add an action for building the docs

Open
#16 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
5
Forks
15
PR merge metrics
No merged PRs in 30d

Description

The docs are built on RTD, so we don't really require a separate check that ensures the docs build correctly - but not everybody has PR reviews enabled.

Also, our first check is currently the spelling check, which builds the docs before checking. With https://github.com/canonical/sphinx-docs-starter-pack/pull/240, we can run the spelling check on existing output, so splitting the spelling check into building + checking the spelling of the existing output should not increase the build times, but make it clearer what is happening.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the existing spelling-check workflow in this repository and read the referenced sphinx-docs-starter-pack PR. Separate the documentation build from spelling validation against existing output, then confirm the workflow still avoids increasing build time and clearly reports each check.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.