changelog is not included in the documentation
Metadata
Current evaluation
Documentation gaps were fixed by merged PR #296 (commit 1e16ba5), adding the changelog and Starbase-based docs tooling/layout with tox support; the maintainer confirmed all four concerns were addressed.
Resolution: closed resolved
Reason: PR #296 was merged as commit 1e16ba5. A maintainer explicitly closed #221 after confirming that the changelog, docs CI, warning cleanup, and tox-based build workflow had all been addressed.
Evaluated by: mr-cal-bot
No scores available.
Issue body
I wanted to look up some recent API changes, but I could not easily find your changelog, as it is not included on https://craft-providers.readthedocs.io/en/latest/
I finally found it inside the docs folder, so it is there, but just not included.
sphinx warns when an existing file is not included, and imho it is a good idea to enable strict mode for sphinx, which turns all warnings into errors.
Currently there are a lot of warnings, which hide real issues like the missing changelog:
```
build succeeded, 172 warnings.
```
Currently, building the documentation locally is rather cumbersome, at least since you dropped the tox configuration file.
Now, instead of running just `tox -e docs` I need to
- create a virtualenv
- look up the dependencies I need to install in the setup file
- run make
If you ever consider to re-introduce tox, similar to https://github.com/canonical/craft-cli/blob/4436263bc1cdb4cb940372c25a42959a73695a4a/tox.ini#L13-L14 please let me know, I'd volunteer to create a PR (at least for the docs step for now).
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Documentation gaps were fixed by merged PR #296 (commit 1e16ba5), adding the changelog and Starbase-based docs tooling/layout with tox support; the maintainer confirmed all four concerns were addressed. | |
| qwen/qwen3.6-35b-a3b | — | closed resolved | The missing changelog in the documentation and related build process issues were resolved by PR #296. |
Update history
| Date | Change |
|---|---|
| created |
Related work
-
Likely Fixed By:
canonical/craft-providers#296
(confidence 100%)
Merged docs tooling and layout change cited by the maintainer as resolving all four concerns.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #607 docs(changelog): update to starbase conventions | craft-providers | merged | Merged PR #607 (commits e2bf0b9, e870c6f, 604233d) refactoring the changelog to starbase conventions: ordered by date, human-readable dates, moved to docs/reference/changelog.rst. Closes #604. | |
| #296 docs: add doc tooling and layout from starbase | craft-providers | merged | Merged PR #296 as commit 1e16ba5, adding documentation tox targets, a Diátaxis layout, README.rst, HACKING.rst, and minor reformatting. |