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

Set homepage layout explicitly using index.md #156

Merged
merged 1 commit into from
Mar 18, 2025
Merged

Conversation

cdot65
Copy link
Owner

@cdot65 cdot65 commented Mar 18, 2025

User description

Checklist for This Pull Request

🚨Please adhere to the guidelines for contributing to this repository.

  • Ensure you are submitting your pull request to a branch dedicated to a specific topic/feature/bugfix. Avoid using the master branch for pull requests.
  • Target your pull request to the main development branch in the https://github.com/cdot65/pan-scm-sdk repository (do NOT target the Palo Alto Networks repo!).
  • Check that your code additions do not fail any linting checks or unit tests.

Pull Request Description

Correcting mkdocs build.

What does this pull request accomplish?

  • Bug fix

Are there any breaking changes included?

  • Yes
  • No

PR Type

Bug fix, Documentation


Description

  • Explicitly set homepage layout using index.md

  • Update not_in_nav configuration in mkdocs.yml

  • Improve clarity and accuracy of homepage definition


Changes walkthrough 📝

Relevant files
Configuration changes
mkdocs.yml
Update homepage layout configuration                                         

mkdocs.yml

  • Changed not_in_nav from boolean to string value
  • Set not_in_nav to explicitly point to index.md
  • Ensures accurate homepage layout definition
  • +2/-1     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • Updated the `not_in_nav` configuration to explicitly point to `index.md`. This ensures the homepage layout is accurately defined and improves clarity in the configuration file.
    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    Correct YAML syntax for configuration

    The not_in_nav option should be a boolean value or a list of files, not a string.
    Consider changing it to a list containing 'index.md' or setting it to true if you
    want to exclude all pages not explicitly listed in the navigation.

    mkdocs.yml [71-72]

     # Explicitly set the layout for home page with customizations
    -not_in_nav: |
    -  index.md
    +not_in_nav:
    +  - index.md
    Suggestion importance[1-10]: 8

    __

    Why: The suggestion correctly identifies a syntax issue in the YAML configuration. The proposed change improves the structure and adheres to the correct format for the 'not_in_nav' option, which is crucial for proper MkDocs configuration.

    Medium

    @cdot65 cdot65 merged commit 2222638 into main Mar 18, 2025
    2 checks passed
    @cdot65 cdot65 deleted the hotfix/not_in_nav branch March 18, 2025 13:04
    Copy link

    codecov bot commented Mar 18, 2025

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    ✅ All tests successful. No failed tests found.

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

    Successfully merging this pull request may close these issues.

    1 participant