Security Navigation Updates¶
This document outlines the changes needed to update the mkdocs.yml navigation to reflect the reorganized security section structure.
Current Navigation (Before)¶
Updated Navigation (After)¶
Changes Summary¶
- Main Navigation
- Changed security overview link from
security/overview.md
tosecurity/index.md
-
Added
security/inventory.md
as "Directory" -
New Subdirectory Navigation
-
Added five new subdirectory sections:
- Security Principles
- Risk Analysis
- Threat Model
- Compliance
- Recommendations
-
Entry Points and Content
-
Each subdirectory has:
- Overview (index.md)
- Directory (inventory.md)
- Topic-specific content files
-
Removed Obsolete Entries
- Removed direct links to old files:
security/risk-analysis.md
security/analysis.md
security/compliance.md
security/overview.md
Implementation Notes¶
When implementing this navigation update:
- Ensure all file paths are correct (especially watch for typos in directory names)
- Verify that all referenced files exist in the correct locations
- Maintain proper indentation in the YAML structure
- Test navigation after changes to ensure all links work correctly
- The old files can be retained in the repository as redirects to their new locations if needed
Benefits¶
- Logical Organization
- Clear, hierarchical structure for security documentation
-
Improved content discoverability
-
Progressive Disclosure
- Top-level navigation shows major security categories
-
Drill-down for detailed information
-
Consistency
- Follows the same pattern used in the approaches section
- Standardized structure across documentation
This navigation update should be applied to the mkdocs.yml file as part of completing the security section reorganization.