Skip to content

docs: quality triage — broken links, orphaned pages, content fixes (Phase 1 of #8) - #7

Open
ajile-in wants to merge 2 commits into
mainfrom
docs/quality-triage
Open

docs: quality triage — broken links, orphaned pages, content fixes (Phase 1 of #8)#7
ajile-in wants to merge 2 commits into
mainfrom
docs/quality-triage

Conversation

@ajile-in

@ajile-in ajile-in commented Aug 21, 2026

Copy link
Copy Markdown
Member

🗺️ Part of #8 — Docs improvement initiative roadmap (Phases 1–4). This PR delivers Phase 1: Quality triage. See the tracking issue for the full roadmap and locked decisions.

Summary

Phase 1 fixes every critical/high issue found in the docs audit: orphaned pages, broken links, expiring assets, invalid samples and content errors.

Commits

1. Navigation, links & assets (f2c3f76)

  • SUMMARY.md: add the 3 orphaned pages (OID4VC Issuer API, OID4VP Verifier API, Ecosystem & Trust Service) — unreachable via nav and missing from the site's llms.txt agent index
  • Replace dead app.gitbook.com/~/revisions/... prerequisite links with relative links into the Service setup guide
  • Fix stale anchors: implementations.md#credebl-saas#sovio.id; service-setup.md#top#keycloak (×3)
  • Replace GitBook revision URL in Service setup with a relative link to the v2.1.0 release page
  • Point http://nextauth.js (nonexistent) to next-auth.js.org
  • Getting Started: Platform card now targets the local setup guide (was mislabeled "Platform APIs" → API reference)
  • Vendor the 5 SendGrid screenshots from the expiring Google Docs CDN into .gitbook/assets/sendgrid/

2. Content correctness (86b8a8b)

  • Both Studio guides: reversed version gates fixed — older = before v2.1.0, newer = v2.1.0+
  • cliConfig.json sample is now valid JSON: inline comments removed, "postgres",, fixed, fileServerToken placeholder added, polygon-mainnet snippet comma added; documented field name corrected to label
  • Ecosystem doc: garbled consent-notice sentence repaired; stale TOC entries (3.3 Template, 4 Cross-Ecosystem Access) pruned with explicit coming-soon note
  • Features: merged Privacy/Integrity bullet split; "Verification credential Stake-holders" → "Verifiable credential stakeholders"
  • Copyright & License: mangled backtick/bold markdown rewritten as clean paragraphs
  • Typos: Keyclock→Keycloak, postures→PostgreSQL, platfrom→platform, resistent→resistant, Endor→Endorser, noticeUrl override grammar, "A wallet…", Studio description grammar
  • Local deployment: truncated "Access the CREDEBL API" step completed with gateway URL; OID4VC cross-refs repointed to in-page sections

✅ Verification

  • grep sweep clean for all removed patterns
  • Extracted cliConfig.json passes jq
  • Scripted repo-wide check: all relative .md links resolve
  • DCO sign-off present on both commits

📝 Notes for reviewers

  • One item intentionally not changed: GET /v1/ecosystem/invitations?orgId={ecosystemId} param-name vs description mismatch — tracked as an open question in Docs improvement initiative: roadmap (Phases 1–4) #8, needs platform-team confirmation.
  • Known remaining placeholders (deliberately out of Phase 1 scope): empty (#) links for Consent Service / X509 guides in OID4VC Issuer API — candidates for Phase 4 follow-up once those guides exist.

ℹ️ After merge: GitBook auto-syncs main, so these changes go live on docs.credebl.id and the previously hidden pages appear in nav + llms.txt.

- Add orphaned OID4VC Issuer, OID4VP Verifier and Ecosystem pages to SUMMARY nav
- Replace dead app.gitbook.com revision URLs with relative links
- Fix stale anchors (credebl-saas, Keycloak #top) and a GitBook revision link
- Point NextAuth.js reference to the real site
- Retarget Getting Started Platform card to the local setup guide
- Download SendGrid screenshots from expiring Google Docs CDN into assets

Signed-off-by: Ajay Jadhav <ajay@ayanworks.com>
- Correct backwards version comparisons in both Studio guides (older = pre-v2.1.0)
- Make cliConfig.json sample valid JSON (strip comments, fix double comma,
  add missing fileServerToken value and polygon-mainnet comma); fix 'label' field name
- Fix garbled consent-notice sentence and prune stale TOC entries (3.3/4) in Ecosystem doc
- Split merged Privacy/Integrity bullet in Features; correct stakeholders heading
- Rewrite mangled Copyright & License markdown; misc typos (Keycloak, PostgreSQL,
  phishing-resistant, Endorser, noticeUrl override)
- Complete truncated 'Access the CREDEBL API' step with the gateway URL
- Repoint OID4VC cross-references from removed per-file docs to in-page sections

Signed-off-by: Ajay Jadhav <ajay@ayanworks.com>
@ajile-in
ajile-in force-pushed the docs/quality-triage branch from 86b8a8b to a56f547 Compare August 21, 2026 19:07
@ajile-in ajile-in changed the title docs: quality triage — broken links, orphaned pages, content fixes docs: Phase 1 quality triage — broken links, orphaned pages, content fixes (roadmap: Phases 1–4) Aug 21, 2026
@ajile-in ajile-in changed the title docs: Phase 1 quality triage — broken links, orphaned pages, content fixes (roadmap: Phases 1–4) docs: quality triage — broken links, orphaned pages, content fixes (Phase 1 of #8) Aug 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant