Remove reuse directory#576
Merged
Merged
Conversation
nhennigan
requested review from
SecondSkoll,
akcano,
dwilding,
medubelko,
minaelee,
rkratky and
tang-mm
as code owners
jahn-junior
approved these changes
Apr 22, 2026
jahn-junior
left a comment
jahn-junior
left a comment
Collaborator
There was a problem hiding this comment.
Thanks, @nhennigan! Everything seems to build and render just fine.
I left one suggestion, but it isn't a blocker.
medubelko
requested changes
Apr 22, 2026
medubelko
left a comment
medubelko
left a comment
Collaborator
There was a problem hiding this comment.
We'll need to trim these lines, too: https://github.com/canonical/sphinx-docs-starter-pack/blob/main/docs/how-to/update-starter-packs/new-starter-pack.rst?plain=1#L159-L164
Remove the reuse directory. Update all links from links.txt into the individual files. Move the substitutions to the conf.py. Update the docs that pointed to the reuse dir components. Move mermaid code and component code to assets dir
nhennigan
force-pushed
the
docpr-2393-resuse
branch
from
95b6cf9 to
8247bdc
Compare
Move rst links to line as they are once off links. Updated CHANGELOG. Removed files that were deleted on main that remained after rebase. Address other minor review comments
medubelko
approved these changes
Apr 23, 2026
medubelko
left a comment
medubelko
left a comment
Collaborator
There was a problem hiding this comment.
All my comments are addressed. Thanks @nhennigan!
jahn-junior
added
the
Awaiting release
Collaborator
|
Test failures unrelated to changes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
We have been asked to remove the resue directory to reduce the overall complexity of the starter pack. This PR remove the directory, moves the relevant files into new locations and updates references to the directory.
Solution
Removed reuse/ dir
Moved mermaid.txt and components.yaml to /assets dir
Updated references in the docs. The user can create their own reuse dir if they have the need for one
Updated conf.py
Added links from link.txt to the relevant docs
Have you updated
CHANGELOG.mdwith relevant non-documentation file changes?Have you updated the documentation for this change?