Update CROSS_REFERENCE_VERIFICATION_REPORT.md with the latest link verification results, reflecting an increase in total scanned links and valid links, along with a slight rise in broken links. Enhance DOCUMENTATION_STANDARDS.md by adding guidance for anchor-only and directory links, including examples for better clarity. Revise IMPLEMENTATION_STATUS.md to show improved task completion metrics and overall project status. Update MASTER_INDEX.md and README.md to reflect the expanded document count and recent achievements in project documentation.
This commit is contained in:
@@ -115,6 +115,30 @@ Format: `[Section Name](document.md#section-name)`
|
||||
- `[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
|
||||
|
||||
### Anchor-Only Links
|
||||
Format: `[Section Name](#anchor-name)`
|
||||
|
||||
**Guidance:**
|
||||
- Use for navigation within the same document
|
||||
- Anchor names should match heading IDs (lowercase, hyphens for spaces)
|
||||
- HTML anchor tags: `<a id="anchor-name"></a>` can be used for custom anchors
|
||||
- Markdown headings automatically create anchors (lowercase, spaces to hyphens)
|
||||
|
||||
**Example:**
|
||||
- `[Go to Section](#section-name)` - Links to heading "## Section Name" in same document
|
||||
|
||||
### Directory Links
|
||||
Format: `[Directory Name](path/to/directory/)`
|
||||
|
||||
**Guidance:**
|
||||
- Use when linking to a directory of related documents
|
||||
- Consider linking to a README.md or index file if available
|
||||
- Directory links are valid but may be flagged by verification scripts
|
||||
- Prefer specific file links when possible
|
||||
|
||||
**Example:**
|
||||
- `[Operational Examples](08_operational/examples/)` - Links to examples directory
|
||||
|
||||
### Related Documents Section
|
||||
All major documents shall include a "Related Documents" section at the end listing:
|
||||
- Related statutory code titles
|
||||
|
||||
Reference in New Issue
Block a user