Skip to content

docs(offline): add manual testing and troubleshooting guide - #207

Open
Varsha20064 wants to merge 3 commits into
vicharanashala:mainfrom
Varsha20064:varsha/offline-testing-guide
Open

docs(offline): add manual testing and troubleshooting guide#207
Varsha20064 wants to merge 3 commits into
vicharanashala:mainfrom
Varsha20064:varsha/offline-testing-guide

Conversation

@Varsha20064

@Varsha20064 Varsha20064 commented Aug 3, 2026

Copy link
Copy Markdown

What changed

This PR adds a manual testing and troubleshooting guide for the Offline Mode feature so contributors and reviewers can consistently verify service-worker registration, FAQ caching, offline access, uncached-content behaviour, and cache cleanup. It also adds a reusable test-record table and links the guide from the documentation index.

Related issue

Refs #162
Refs #169

Type of change

  • Bug fix
  • Feature
  • Refactor (no behaviour change)
  • Docs / comments only
  • CI / tooling

Area affected

  • Backend (Express / Mongoose)
  • Frontend (React / Vite)
  • Admin / Train tab (/admin/*)
  • Community (/community — posts, comments, auto-answer)
  • Search (hybrid text retrieval, training stats)
  • Auth / middleware / samagama.in bridge
  • Crons / schedulers / embedding-warm
  • Observability (Sentry / logging / Discord alerts)
  • Docs

CI verification

  • cd apps/backend && npx tsc --noEmit exits 0
  • cd apps/backend && npx vitest run — all tests pass
  • cd apps/frontend && npx tsc --noEmit exits 0
  • cd apps/frontend && npx vitest run — all tests pass
  • pnpm run lint — 0 errors (152 warnings is the baseline)
  • GitHub Actions green on the merge commit (CI, CodeQL, Build & Deploy)
  • Tested with a real API hit or browser interaction if behaviour changed
  • Tests added or updated for the change
  • Single logical change — unrelated fixes noted in description, not fixed here
  • Docs updated if route / API / env var / pipeline behaviour changed
  • Rebased onto main, no merge commits

Notes for reviewer

This is a documentation-only change and does not modify application behaviour. The new guide documents manual QA procedures for the Offline Mode implementation associated with #162 and #169. The Markdown structure and documentation link were reviewed using GitHub Preview. Automated tests were not added or run because no source code was changed.

This document provides a comprehensive guide for manually verifying the Offline Mode feature of the Yaksha FAQ Portal, including prerequisites, test steps, expected results, and a test record table.
Added troubleshooting section for Offline Mode testing.
Added a section for Offline Mode Testing in the README.
@Varsha20064 Varsha20064 changed the title Varsha/offline testing guide docs(offline): add manual testing and troubleshooting guide Aug 3, 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