SCORM Docs Link Audit
Updated 2026-03-27. Validates /docs links against markdown sources under docs/scorm-api/**.
Link Inventory & File Mapping
/docs Link |
Expected Markdown Path | Status | Notes |
|---|---|---|---|
/docs/scorm-api/getting-started/quick-start |
docs/scorm-api/getting-started/quick-start.md |
✅ | File exists |
/docs/scorm-api/resources/examples |
docs/scorm-api/resources/examples.md |
✅ | examples.md is the landing page for this slug |
/docs/scorm-api/architecture/architecture-overview |
docs/scorm-api/architecture/architecture-overview.md |
✅ | File exists |
/docs/scorm-api/architecture/system-design |
docs/scorm-api/architecture/system-design.md |
✅ | File exists |
/docs/scorm-api/guides/cmi-data-guide |
docs/scorm-api/guides/cmi-data-guide.md |
✅ | File exists |
/docs/scorm-api/guides/integration/trainingos-integration |
docs/scorm-api/guides/integration/trainingos-integration.md |
✅ | File exists |
/docs/scorm-api/getting-started/first-package |
docs/scorm-api/getting-started/first-package.md |
✅ | File exists |
/docs/scorm-api/getting-started/first-session |
docs/scorm-api/getting-started/first-session.md |
✅ | File exists |
/docs/scorm-api/getting-started/first-report |
docs/scorm-api/getting-started/first-report.md |
✅ | File exists |
/docs/scorm-api/guides/dispatch/dispatch-overview |
docs/scorm-api/guides/dispatch/dispatch-overview.md |
✅ | File exists |
/docs/scorm-api/guides/security/api-key-security |
docs/scorm-api/guides/security/api-key-security.md |
✅ | File exists |
/docs/scorm-api/guides/rate-limiting |
docs/scorm-api/guides/rate-limiting.md |
✅ | File exists |
/docs/scorm-api/reference/error-codes |
docs/scorm-api/reference/error-codes.md |
✅ | File exists |
/docs/scorm-api/guides/security/security-overview |
docs/scorm-api/guides/security/security-overview.md |
✅ | File exists |
/docs/scorm-api/guides/webhooks/webhook-setup |
docs/scorm-api/guides/webhooks/webhook-setup.md |
✅ | File exists |
/docs/scorm-api/guides/performance/optimization-guide |
docs/scorm-api/guides/performance/optimization-guide.md |
✅ | File exists |
/docs/scorm-api/guides/performance/scaling-guide |
docs/scorm-api/guides/performance/scaling-guide.md |
✅ | File exists |
/docs/scorm-api/resources/faq |
docs/scorm-api/resources/faq.md |
✅ | File exists |
Non-doc links (
/api/docs,/onboarding/checkout,/features,/, andmailto:URLs) were excluded from the mapping table.
Dynamic route behaviour
The app docs/[...slug] route resolves markdown by slug path. Folder-style URLs should use a concrete *.md filename (e.g. resources/examples.md for the examples index).
Follow-ups
- Optional: add
pnpm lint:docsto enumerate/docslinks and fail on missing files.