Update CROSS_REFERENCE_VERIFICATION_REPORT.md with revised link verification results, reflecting an increase in total scanned links and valid links, while reducing broken links and improving the success rate. Enhance DOCUMENTATION_STANDARDS.md with clearer examples for internal and section references. Revise FAQ documents to include more descriptive references for operational guides and examples. Update formatted_book/DBIS_Institutional_Book_Structure.md to improve navigation with added anchor tags for sections. Modify verify_links.py to check for both files and directories, enhancing link verification accuracy.

This commit is contained in:
defiQUG
2025-12-08 03:59:56 -08:00
parent dea76aeec1
commit 13bad3aef2
8 changed files with 390 additions and 160 deletions

View File

@@ -103,15 +103,17 @@ Use **Semantic Versioning (SemVer)** format: `MAJOR.MINOR.PATCH`
### Internal Document References
Format: `[Document Title](relative/path/to/document.md)`
**Examples:**
- `[Title VI: Cyber-Sovereignty](02_statutory_code/Title_VI_Cyber_Sovereignty.md)`
- `[CSP-1113 Technical Specification](csp_1113/CSP-1113_Technical_Specification.md)`
**Examples (Note: These are example formats, not actual links):**
- `[Title VI: Cyber-Sovereignty](02_statutory_code/Title_VI_Cyber_Sovereignty.md)` - ✅ Valid example
- `[CSP-1113 Technical Specification](csp_1113/CSP-1113_Technical_Specification.md)` - ✅ Valid example
- `[Document Title](relative/path/to/document.md)` - ⚠️ Example format only
### Section References
Format: `[Section Name](document.md#section-name)`
**Example:**
- `[Section 1.1: Server Standards](11_technical_specs/Technical_Standards.md#section-11-server-standards)`
**Examples (Note: These are example formats, not actual links):**
- `[Section 1.1: Server Standards](11_technical_specs/Technical_Standards.md#section-11-server-standards)` - ⚠️ Example format only
- `[Section Name](document.md#section-name)` - ⚠️ Example format only
### Related Documents Section
All major documents shall include a "Related Documents" section at the end listing: