docs: replace previous docs with sphinx docs#154
Open
AloizioMacedo wants to merge 10 commits intocanonical:masterfrom
Open
docs: replace previous docs with sphinx docs#154AloizioMacedo wants to merge 10 commits intocanonical:masterfrom
AloizioMacedo wants to merge 10 commits intocanonical:masterfrom
Conversation
a4b59ae to
43e31e4
Compare
43e31e4 to
1498e29
Compare
wyattrees
previously approved these changes
Apr 17, 2026
Contributor
wyattrees
left a comment
There was a problem hiding this comment.
+1, although it looks like some tests need to either be removed or refactored.
Also, if I'm not mistaken, the description of the PR gets included in the commit message when merge happens, so make sure that it complies with our conventional commits spec
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
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.
This PR replaces the previous documentation with the new one, which uses sphinx and leverages read the docs as hosting platform. As part of this, it does the last step of replacing the offline docs (it is convenient to do both at once when changing
snapcraft.yaml, since we will not need to temporarily build two docs on the snap).Before opening for review, this will wait for:
Formal approval on the spec, since it is a destructive process.DoneOther PRs that implement things related to the transition spec. As of this moment, docs: automate cli docs generation #144.DoneThis will also finalize the transition process.
Tips on reviewing: Commits
remove docs folder,remove offline-docs,rename rtd-docs to docsshould be reviewed as high level changes, as they are only overarching removals and renamings.