Skip to content

Commit 246907f

Browse files
feat: simplify documentation to single-page modifications view
- Generate modifications directly on homepage (docs/index.md) - Remove dual-page navigation (Home | Modifications tabs) - Delete obsolete docs/modifications/ directory - Streamline user experience with direct content access BREAKING CHANGE: URL structure changed - Old: /f5xc-api-fixed/modifications/ - New: /f5xc-api-fixed/
1 parent e594a7f commit 246907f

File tree

4 files changed

+12
-38
lines changed

4 files changed

+12
-38
lines changed

docs/index.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,13 @@ Validated and reconciled F5 Distributed Cloud OpenAPI specifications.
44

55
This project validates F5 XC OpenAPI specifications against the live API, identifies discrepancies, and produces corrected spec files.
66

7-
[View All Modifications](modifications/index.md){ .md-button .md-button--primary }
7+
*Last updated: 2026-01-26 04:19 UTC*
88

9-
## Downloads
9+
## Summary
1010

11-
Get the latest validated specs from the [GitHub Releases](https://github.com/robinmordasiewicz/f5xc-api-fixed/releases) page.
11+
- **Modified Files**: 0
12+
- **Unmodified Files**: 0
13+
- **Total Discrepancies**: 0
1214

13-
## Validation Process
14-
15-
Each release contains specs that have been validated using:
16-
17-
- **OpenAPI Spec Validator** - Structural validation
18-
- **Schemathesis** - Property-based testing against live API
19-
- **Custom Constraint Validation** - Boundary testing for all constraint types
20-
21-
## Release Contents
22-
23-
- `openapi.json` / `openapi.yaml` - Merged OpenAPI specification
24-
- `domains/` - Individual domain-specific spec files
25-
- `CHANGELOG.md` - List of modifications applied
26-
- `VALIDATION_REPORT.md` - Summary of validation results
15+
!!! success "No Modifications Required"
16+
All specs match live API behavior. No modifications were applied.

docs/modifications/index.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

mkdocs.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,3 @@ extra_css:
7474

7575
extra_javascript:
7676
- javascripts/sidebar-fix.js
77-
78-
nav:
79-
- Home: index.md
80-
- Modifications: modifications/index.md

scripts/generate_docs.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@ def load_validation_report(report_path: Path) -> dict | None:
3030
def generate_modifications_page(report: dict | None, output_path: Path) -> None:
3131
"""Generate the modifications/index.md page from validation report."""
3232
lines = [
33-
"# Spec Modifications",
33+
"# F5 XC API Fixed Specs",
3434
"",
35-
"This page shows all modifications applied to reconcile F5 XC OpenAPI specs with live API behavior.",
35+
"Validated and reconciled F5 Distributed Cloud OpenAPI specifications.",
36+
"",
37+
"This project validates F5 XC OpenAPI specifications against the live API, identifies discrepancies, and produces corrected spec files.",
3638
"",
3739
]
3840

@@ -203,7 +205,7 @@ def main() -> int:
203205
parser.add_argument(
204206
"--output",
205207
type=Path,
206-
default=Path("docs/modifications/index.md"),
208+
default=Path("docs/index.md"),
207209
help="Output path for modifications page",
208210
)
209211

0 commit comments

Comments
 (0)