Browser audit checklist (frontend)

Run the docs locally, then open http://localhost:8000 and use this checklist.

docker run -d --name docs-audit -p 8000:8000 docs:local
# Open http://localhost:8000 in your browser

1. Home (/) and layout

  • [ ] Home loads — Index shows “GitiNext Backend Documentation” and Start Here sections.
  • [ ] Nav matches mkdocs — Sidebar shows Overview, Architecture, Portals, Status, Migration, Guides, API Reference, Tutorials.
  • [ ] Search — Search box in sidebar; submitting a query goes to /search?q=....
  • [ ] No “Coming Soon” on home or any nav item you click.

  • [ ] All nav links resolve — Click each section (Overview, Architecture, API Reference, Tutorials, Migration phases 0–6). Every link should open a real page, not “Coming Soon”.
  • [ ] Index links — From home, links under “Start Here”, “Documentation Sections”, “Migration”, “Archive” go to the correct /docs/... pages.
  • [ ] Internal links — From e.g. Introduction, “Quick Start Guide” and “Wallet Service Guide” work.
  • [ ] External links — GitHub, Swagger, nextgiti.cloud open in new tab (or same tab if you prefer; document which).

3. Content and readability

  • [ ] Headings — H1/H2/H3 have clear hierarchy; “On This Page” TOC (if present) matches headings.
  • [ ] Code blocks — Go, bash, YAML use monospace and syntax highlighting where expected.
  • [ ] Mermaid — Flowcharts on Key Flows, migration phases, API reference render (no raw mermaid code visible).
  • [ ] Tables — Tables (e.g. API Reference, migration tasks) are readable and not broken on narrow width.

4. Responsive and mobile

  • [ ] Sidebar — On narrow viewport, sidebar toggles (e.g. ☰); overlay closes sidebar when clicking outside.
  • [ ] Content — Main content doesn’t overflow horizontally; code and tables wrap or scroll.
  • [ ] Touch — Buttons/links are usable on touch (no tiny hit areas).

5. Performance and assets

  • [ ] Fonts — Inter and JetBrains Mono load (no FOUT or long blank text).
  • [ ] Static/static/css/style.css and /static/js/app.js return 200 (check Network tab).
  • [ ] No console errors — Console free of JS errors on home and 2–3 inner pages.

6. Key pages (smoke)

  • [ ] Overview → Introduction — Mission, architecture, roadmap visible.
  • [ ] Architecture → Key Flows — Auth, Deposit, Withdrawal, Payment flowcharts visible.
  • [ ] API Reference → Gateway REST — Overview, endpoints, mermaid diagram.
  • [ ] Tutorials → First Service — Steps and code blocks render.
  • [ ] Migration → Phase 0 — Task list and flowchart.

7. Production readiness

  • [ ] Title/meta — Each page has a sensible <title> and description.
  • [ ] Footer — Copyright, GitHub, Website links present and correct.
  • [ ] HTTPS — On docs.nextgiti.cloud, site is served over HTTPS and mixed content is avoided.

After the audit, stop the container:

docker stop docs-audit && docker rm docs-audit

© 2025 GitiNext - Enterprise Crypto Infrastructure | GitHub | Website