mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-10-03 17:14:33 -04:00
39 lines
2.4 KiB
HTML
39 lines
2.4 KiB
HTML
<h1 id="help--in-app-docs">Help & In-App Docs</h1>
|
||
|
||
<p>This same user documentation ships <strong>inside the app</strong>, so you can read it offline without leaving Meshtastic. Open it from <strong>Settings → Help & Documentation</strong>.</p>
|
||
|
||
<h2 id="browsing">Browsing</h2>
|
||
|
||
<p>The docs browser lists every user-guide page. Tap a page to read it; images and cross-links work just like they do here.</p>
|
||
|
||
<p><img src="../../assets/screenshots/docs-browser_toc.png" alt="In-app documentation browser table of contents" /></p>
|
||
|
||
<h3 id="search">Search</h3>
|
||
|
||
<p>Tap the search field at the top of the docs browser to open a full-screen search view. Type to filter pages by title and keywords — results update as you type, under the same field. The back arrow, or the keyboard’s search action, closes the view. The field hides while you scroll down the page list and comes back when you scroll up.</p>
|
||
|
||
<p><img src="../../assets/screenshots/docs-browser_search.png" alt="Searching the in-app documentation" /></p>
|
||
|
||
<p>A page open in the browser:</p>
|
||
|
||
<p><img src="../../assets/screenshots/docs-browser_page.png" alt="A documentation page rendered in the app" /></p>
|
||
|
||
<h2 id="chirpy--the-ai-assistant">Chirpy — the AI Assistant</h2>
|
||
|
||
<p><strong>Chirpy</strong> answers plain-language questions about Meshtastic using this bundled documentation as its source. Tap the Chirpy button in the docs browser, type a question, and it replies with an answer and links to the relevant pages.</p>
|
||
|
||
<p><img src="../../assets/screenshots/docs-browser_chirpy.png" alt="Chirpy AI assistant answering a question with page links" /></p>
|
||
|
||
<p>Chirpy is Google-flavor Android only. On F-Droid, desktop and iOS builds the assistant button does not appear at all — the same is true on a phone whose hardware cannot run the on-device model. Browsing and the docs browser’s own search work normally on every platform.</p>
|
||
|
||
<blockquote>
|
||
<p>🔒 <strong>Privacy:</strong> On supported phones running the Google-flavor build, Chirpy runs <strong>on-device</strong> using Gemini Nano — your questions never leave your phone. A small model downloads on first use.</p>
|
||
</blockquote>
|
||
|
||
<h2 id="related-topics">Related Topics</h2>
|
||
|
||
<ul>
|
||
<li><a href="translate">Translate the App</a> — how these pages get localized into other languages</li>
|
||
<li><a href="app-functions">App Functions</a> — the separate system-AI integration (distinct from Chirpy)</li>
|
||
</ul>
|