Skip to content

docs(core): comprehensive user, developer, model, and privacy guides (#19) - #39

Closed
MrSpideyNihal wants to merge 9 commits into
developmentfrom
feature/issue-19-docs
Closed

MrSpideyNihal wants to merge 9 commits into
developmentfrom
feature/issue-19-docs

Conversation

@MrSpideyNihal

Copy link
Copy Markdown
Owner

Summary

Implements Issue #19 — Comprehensive user, developer, model download, and privacy documentation. Creates detailed markdown guides explaining operational procedures and architectural layers.

Changes

Documentation Files

  • Created docs/user_guide.md: Quick start steps, full application UI layouts, overrides behavior, and application keyboard shortcuts reference table.
  • Created docs/developer_guide.md: Core system architecture diagram (Mermaid flow representation), directory layouts, schema configurations for SQLite backend tables, development environment setup, and verification Makefile targets.
  • Created docs/model_download.md: Standard platform search directories, instructions for downloading/extracting Vosk model packs, and HuggingFace Whisper offline cached model copies.
  • Created docs/privacy.md: Zero network interactions policy documentation, complete local storage directories inventory table, and transparency verification instructions.

Verification Results

  • Reviewed markdown links.
  • Verified that all documents are structured logically.

Closes #19

@MrSpideyNihal

Copy link
Copy Markdown
Owner Author

Superseded: all changes from this branch have been merged into main directly. Closing as stale.

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