[SC 9539] Keep order of the sections while previewing the template

[AnilSorathiya]

Internal Notes for Reviewers

When you call preview_template() for model documentation, validation reports, or ongoing monitoring reports, it will spit out the preview with the sections ordered as they are displayed in the YAML instead of honouring the custom order specified. For example:

Custom Template Order	Incorrect Preview

This change will sort the section tree by the order of the sections in the template (if provided) and set the order to 9999 for the sections that do not have an order.

[github-actions]

PR Summary

This pull request enhances the sorting logic of the section tree in the _convert_sections_to_section_tree function within the validmind/template.py file. Previously, sections without an explicit order were sorted with a default order of 0. This PR changes the default order for sections without an explicit order to 9999, ensuring that these sections are placed at the end of the sorted list. This change improves the handling of unordered sections by clearly distinguishing them from those with a specified order.

The modification involves updating the lambda function used in the sorted call to set the default order to 9999 instead of 0.

Test Suggestions

• Test with a template where all sections have explicit orders to ensure they are sorted correctly.
• Test with a template where some sections do not have an explicit order to verify they are placed at the end.
• Test with a template where no sections have an explicit order to confirm they are all sorted with the default order of 9999.
• Test with an empty template to ensure no errors occur and the function handles it gracefully.

[johnwalz97]

nice 👌