Skip to content

Changes docs dir structure from flat to Diataxis-based#567

Open
rkratky wants to merge 1 commit into
canonical:mainfrom
rkratky:doc-subdirs
Open

Changes docs dir structure from flat to Diataxis-based#567
rkratky wants to merge 1 commit into
canonical:mainfrom
rkratky:doc-subdirs

Conversation

@rkratky
Copy link
Copy Markdown
Contributor

@rkratky rkratky commented Jan 18, 2026

Description

  • Moves topic files to resp. sub-dirs
  • Updates docs validation and manpage building scripts
  • Adds internal redirects to keep all links functional

Note: Most work on this done by @davidekete in PR #520. Thanks! More context added in a comment under that PR.

Checklist

  • Runs make check successfully.
    • meson.build specifies an invalid pycoverage arg -cove-append; without it, the test passes
  • Retains code coverage (make check-coverage).
    • The documentation target passes
    • coverage-c and coverage-py fail, but those are not relevant to this PR
  • [n/a] New/changed keys in YAML format are documented.
  • [n/a] (Optional) Adds example YAML for new feature.
  • [n/a] (Optional) Closes an open bug in Launchpad.

  * Moves topic files to resp. sub-dirs
  * Updates docs validation and manpage building scripts
  * Adds internal redirects to keep all links functional

Note: Most work on this done by @davidekete in PR canonical#520. Thanks!
@rkratky rkratky added enhancement New feature or request documentation Documentation improvements. labels Jan 18, 2026
@rkratky rkratky requested a review from slyon January 19, 2026 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation improvements. enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant