Skip to content

Conversation

@CapnKernel
Copy link
Contributor

@CapnKernel CapnKernel commented Dec 19, 2025

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.md file previously in the top level docs dir has been moved one level deeper to docs/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 file docs/docs/README.md, because mkdocs says it clashes with docs/docs/index.md.

There are three commits.

  1. Already sent in Improvements to the documentation instructions #11044.
  2. Move docs/README.md to docs/docs/documentation-howto.md with no changes.
  3. Changed examples to stop mkdocs interpreting {{ image() }} and {{ icon() }}, and added documentation-howto.md to mkdocs.yaml.

I suggest reviewing them as commits, rather than the end-to-end changes.

@netlify
Copy link

netlify bot commented Dec 19, 2025

Deploy Preview for inventree-web-pui-preview canceled.

Name Link
🔨 Latest commit d0ad2e1
🔍 Latest deploy log https://app.netlify.com/projects/inventree-web-pui-preview/deploys/69455504a5deb100081ac4e0

@SchrodingersGat
Copy link
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:

image

Maybe instead of "this repository hosts..." it should be something like "This page describes..."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants