Skip to content

Conversation

@afernandez-nhs
Copy link
Contributor

  • Introduced a new YAML file to define the order of sections in the sidebar navigation.
  • Updated the page layout to utilize the defined section order, ensuring sections not listed appear at the end in alphabetical order.

Description

This change implements a configurable sidebar section ordering system for the NHS Notify documentation. A new YAML configuration file (docs/_data/sidebar-section-order.yml) has been created to define the preferred order of navigation sections. The page layout template has been updated to read this configuration and display sections in the specified order, with any sections not explicitly listed appearing at the end in alphabetical order.

Context

The sidebar navigation was previously displaying sections in an arbitrary order, which could be confusing for users trying to navigate through the documentation. This change provides a structured and predictable navigation experience by allowing explicit control over section ordering while maintaining flexibility for new sections.

Type of changes

  • Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I am familiar with the contributing guidelines
  • I have followed the code style of the project
  • I have added tests to cover my changes
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

  • I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

* Introduced a new YAML file to define the order of sections in the sidebar navigation.
* Updated the page layout to utilize the defined section order, ensuring sections not listed appear at the end in alphabetical order.
@afernandez-nhs afernandez-nhs requested a review from a team as a code owner July 10, 2025 11:09
Copy link
Contributor

@jakecosgrove jakecosgrove left a comment

Choose a reason for hiding this comment

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

All looks great! Thank you for sorting this annoying little issue!

@jakecosgrove jakecosgrove merged commit aed152f into main Jul 10, 2025
16 of 17 checks passed
@jakecosgrove jakecosgrove deleted the CCM-10850-clean branch July 10, 2025 15:15
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