Skip to content
545 changes: 545 additions & 0 deletions docs/source/ai.rst

Large diffs are not rendered by default.

9 changes: 7 additions & 2 deletions docs/source/cloud_sync.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,15 @@ What Gets Synced
**Workspaces** (toggle: Workspaces)
Workspace configurations, window layouts, and current document positions.

**AI settings** (synced with Workspaces)
Custom AI prompts and provider configurations (provider type, model,
endpoint). API keys, cache, and usage data are **not** synced -- you need
to enter your API key on each device separately. See :doc:`ai` for details.

**Not synced:**
Bible and commentary modules themselves are not synced.
Download your modules separately on each device. App settings and preferences
are also not synced.
Download your modules separately on each device. App settings, preferences,
AI API keys, and AI cache are also not synced.

How Sync Works
--------------
Expand Down
70 changes: 70 additions & 0 deletions docs/source/experimental_features.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
Experimental Features
=====================

|app| includes a number of experimental features that are still in development.
These features may change, be improved, or be removed in future versions. You
can enable or disable them individually.

.. note::

Experimental features are disabled by default. Enable only the ones you want
to try -- they may have rough edges or incomplete functionality.


Enabling Experimental Features
------------------------------

#. Open the top left main menu (|hamburger|).
#. Tap ``Settings``.
#. Scroll down to ``Advanced Settings``.
#. Tap ``Experimental features``.
#. Check the features you want to enable.
#. Tap ``OK``.


Available Features
------------------

AI Text Processing
^^^^^^^^^^^^^^^^^^^

When enabled, this feature unlocks the full :doc:`AI assistant <ai>`
functionality. You must also have a configured AI provider for AI features to
appear.

Once enabled:

* An **AI Text Processing** prompt selector appears in the window's text display
settings, allowing you to process entire chapters through AI (e.g. translate
or annotate a whole chapter at once).
* **AI action buttons** appear in verse selection, text selection, and window
menus.

See :doc:`ai` for full details on setting up a provider, using prompts, and
managing costs.

.. note::

This feature requires both the experimental feature toggle **and** a
configured AI provider. If either is missing, AI options will not appear.


Add Paragraph Break Bookmark
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Adds a **Paragraph break** option to the verse context menu. When used, it
creates a special bookmark that inserts a visual paragraph break before the
selected verse.

This is useful for adjusting the paragraph layout of Bible texts where the
original formatting does not match your reading preference. The breaks are
stored as bookmarks with a special internal label and are visible as extra
spacing between verses.


Bookmark Edit Actions
^^^^^^^^^^^^^^^^^^^^^

Adds edit action controls to bookmarks. When enabled, you can assign an
**Append** or **Prepend** action to a bookmark, which allows adding custom
content before or after the bookmarked verse in the Bible view.
3 changes: 3 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Contents
:caption: Contents:

getting_started
ai
backup_restore
bible_links
bookmarks
Expand All @@ -28,10 +29,12 @@ Contents
customisation/index
discrete_build
documents
experimental_features
faq
labels
look_and_feel
memorize
my_documents
navigation
notes
reading_plans
Expand Down
Loading