Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add navigation.indexes feature to mkdocs-material #1101

Merged
merged 11 commits into from
Sep 26, 2024

Conversation

PromoFaux
Copy link
Member

What does this PR aim to accomplish?:

Discussed internally, effectively saves a click by making linking the index to the main section header rather than having a subheader for overview/index.

thoughts

I've purposefully left the Docker section as I will be revamping that entire section in another PR


By submitting this pull request, I confirm the following:

  1. I have read and understood the contributors guide, as well as this entire template. I understand which branch to base my commits and Pull Requests against.
  2. I have commented my proposed changes within the code and I have tested my changes.
  3. I am willing to help maintain this change if there are issues with it later.
  4. It is compatible with the EUPL 1.2 license
  5. I have squashed any insignificant commits. (git rebase)

  • I have read the above and my PR is ready for review. Check this box to confirm

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
…add redirect.

Remove images that are not referenced anywhere else

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
…edirects.

Replace references to renamed pages

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux PromoFaux requested review from rdwebdesign, DL6ER and a team September 25, 2024 18:55
Copy link

netlify bot commented Sep 25, 2024

Deploy Preview for pihole-docs ready!

Name Link
🔨 Latest commit 69b6155
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/66f485dd396a760008f0da14
😎 Deploy Preview https://deploy-preview-1101--pihole-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rdwebdesign
Copy link
Member

rdwebdesign commented Sep 25, 2024

What do you think about renaming the initial "Overview" to "About Pi-hole".

image

Like this:

image


Probably something like:

nav:
-  - Overview: index.md
-  - 'About Pi-hole':
+  - 'About Pi-hole': index.md
     - 'Contact Us': main/contact.md
    - 'Pi-hole Origins': main/origins.md
    - 'On the Web': main/coverage.md

Copy link
Member

@yubiuser yubiuser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is a bit inconsistently used: some item suse the index feature, others not (e.g. About Pihole, Getting Started). I think it should behave the same way everywhere.

@rdwebdesign
Copy link
Member

I think it is a bit inconsistently

That's why I suggested the change above.

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux
Copy link
Member Author

PromoFaux commented Sep 25, 2024

I think it should behave the same way everywhere.

The difficulty here is inventing content for the index pages of those sections. I think the only ones where this appears inconsistent now are:

  • Getting Started
  • Docker (Will be addressed in another PR with more Docker docs)
  • Contributing

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@rdwebdesign
Copy link
Member

rdwebdesign commented Sep 25, 2024

  • Contributing

Every page under "Contributing" is related to code contribution in github.

You can do the same as I suggested above for the initial page.
Remove "Contributing", move the content from "Contributing on GitHub" to the top level and fix the links:

contrib

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
@PromoFaux PromoFaux merged commit dbbdddb into release/v6.0 Sep 26, 2024
11 checks passed
@PromoFaux PromoFaux deleted the navigation.indexes branch September 26, 2024 18:59
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.

3 participants