Project Documentation Map
This file serves as a central index for all documentation available in the project, categorized by purpose and target audience. The public entry points are the Markdown docs in this folder; use FEATURES.md as the canonical flavor and capability inventory.
User Guides & Manuals
Essential reading for end-users to install, configure, and use the application. The current public entry points are the Markdown docs in this folder: README.md, QUICK_START.md, HOW_TO.md, FAQ.md, TROUBLESHOOTING.md, LIMITATIONS.md, MODULE_SELECTION.md, and FEATURES.md.
| Document | Description | Last Updated |
|---|---|---|
| What’s New | Release notes for v2.60.6200.317 - new features and fixes since 2.60.6180.134. | 2026-06-20 |
| User Guide / README | Main entry point, project overview, and feature summary. | 2026-07-05 |
| Quick Start Guide | Get up and running in minutes. | 2026-07-05 |
| How-To Guides | Detailed step-by-step instructions for specific tasks. | 2026-07-05 |
| FAQ | Frequently Asked Questions. | 2026-07-05 |
| Troubleshooting | Solutions to common problems. | 2026-06-07 |
| Program Limitations | Known constraints and performance considerations. | Current |
| SMB Setup Guide | Specific guide for setting up network shares. | 2026-02-09 |
| Module Selection | Guide on choosing the right app flavor (Standard, Lite, Photos, Legacy, XR / noLegal). | Current |
| Complete Feature List | Full inventory of all implemented user-facing features. Reference for documentation and changelog. | Current |
| Settings Reference | Every setting explained - what each option does, grouped by section. Also RU, UK. | 2026-06-19 |
| Icon Legend | Every interface icon paired with its exact on-screen label. Also RU, UK. | Current |
Authoring convention: user docs show the real interface icons (not emoji). Convention, regen pipeline, and drift gate: icons/README.md. The inventory, SVGs, and legend are generated - never hand-edited.
Multi-language Support
Most guides are available in Russian and Ukrainian:
- Russian: What’s New, README, Quick Start, How-To, FAQ, Troubleshooting, Limitations, Features
- Ukrainian: What’s New, README, Quick Start, How-To, FAQ, Troubleshooting, Limitations, Features
VR / XR (noLegal) Edition
User-facing guides for the VR / XR headset edition. Each guide is available in English, Russian, and Ukrainian:
Wear OS Companion
Documentation for the Wear OS version of the application.
| Document | Description | Last Updated |
|---|---|---|
| Wear OS Roadmap | Planned features and development status. | 2026-02-02 |
| Wear OS Quick Start | Getting started with the watch app. | 2026-02-09 |
| Wear OS Setup | detailed installation and configuration. | 2026-02-09 |
| Wear OS SMB Setup | Connecting your watch to network shares. | 2026-02-02 |
| Wear OS Build Config | Technical build details. | 2026-02-09 |
| Wear OS Implementation Steps | Development log/tracker. | 2026-02-09 |
| Wear OS Status | Current validation status. | 2026-02-02 |
Legal & Downloads
| Document | Description | Last Updated |
|---|---|---|
| Privacy Policy | 2026-02-02 | |
| Terms of Service | 2026-02-20 | |
| - Downloads: English | Russian | Ukrainian |
Developer & Technical Documentation
Resources for developers, QA, and contributors.
Testing & QA
| Document | Description | Last Updated | |—|—|—| | Build & Test Fast Path | Developer playbook for choosing the cheapest safe local validation path by change type. | 2026-06-24 | | Code Audit Protocol | Project audit protocol for readability, lifecycle safety, memory leaks, startup, and performance regressions in Android code. | 2026-06-26 | | Test Scenarios | Comprehensive test cases. | 2025-11-19 | | Warnings Analysis | Static analysis reports. | 2026-02-02 | | Warnings Summary | Summary of codebase warnings. | 2026-02-02 |
Technical Specifications
| Document | Description | Last Updated | |—|—|—| | Tech Requirements & Stack | Full tech stack, library inventory, platform constraints, min/recommended requirements. | 2026-03-03 | | Device Profile Preset Matrix | Device-profile rationale, provisional preset matrix + change rules, and profile icon asset registry (S0327). | 2026-06-02 |
Current public docs
Date convention: the “User Guides & Manuals” table above carries the authoritative last-edit date for each guide; this table only tracks publish status -
Currentmeans the doc is part of the current public site build, not a second freshness date.
| Document | Description | Last Updated |
|---|---|---|
| README | Main user-facing manual and product overview. | Current |
| Quick Start | First-setup and day-one walkthrough. | Current |
| How-To | Scenario-based guidance for common use cases. | Current |
| FAQ | Common questions and direct answers. | Current |
| Troubleshooting | Practical fixes for common failures. | Current |
| Limitations | Current constraints and performance notes. | Current |
| Module Selection | Flavor selection and build surface overview. | Current |
| Features | Canonical feature inventory used by the public docs. | Current |
Specifications
| Document | Description | Last Updated | |—|—|—| | Architecture Overview | Product structure and implementation map, including the Internet Streams subsystem (HLS/DASH/RTSP/ICY, flavor scope, catalog import). | Current | | Technical Specification | Current implementation-level reference for maintainers. | Current |
UI Communication Policy
| Document | Description | Last Updated | |—|—|—| | Communication Policy | Canonical tone-of-voice policy for all user-visible strings (EN). Voice, message formulas by type, next-step rules, feedback channels, tone checklist. Origin: S0118. | 2026-05-09 | | Communication Policy - Russian | Mirror of communication policy in Russian. | 2026-05-09 | | Communication Policy - Ukrainian | Mirror of communication policy in Ukrainian. | 2026-05-09 |
Note: The public landing pages now point at the current Markdown docs in this repository. Use this map as the canonical index for the shared EN/RU/UK user documentation set.