Move docs/README.md into docs/docs/ so mkdocs can include it#11045
Open
CapnKernel wants to merge 5 commits intoinventree:masterfrom
Open
Move docs/README.md into docs/docs/ so mkdocs can include it#11045CapnKernel wants to merge 5 commits intoinventree:masterfrom
CapnKernel wants to merge 5 commits intoinventree:masterfrom
Conversation
✅ Deploy Preview for inventree-web-pui-preview canceled.
|
Member
|
@CapnKernel please address merge conflicts here. At the top of this page, the wording needs some tweaking now that it is included into the documentation itself:
Maybe instead of "this repository hosts..." it should be something like "This page describes..." |
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.

In discussions about previous changes I'd made to the README.md for docs, we noted that the page wasn't currently reachable from the main docs page, and perhaps we could do that. Well here it is.
With these changes, the
README.mdfile previously in the top level docs dir has been moved one level deeper todocs/docs/documentation-howto.md. I've moved it deeper so mkdocs can see it. (Is there another way that doesn't involve moving it down?) Also, we can't call the moved filedocs/docs/README.md, because mkdocs says it clashes withdocs/docs/index.md.There are three commits.
docs/README.mdtodocs/docs/documentation-howto.mdwith no changes.{{ image() }}and{{ icon() }}, and addeddocumentation-howto.mdtomkdocs.yaml.I suggest reviewing them as commits, rather than the end-to-end changes.