Docs
Powered by

Ax86Docs (on-device documentation)

Ax86Docs is the offline documentation app shipped on Bass: Lineout builds that include --extras. It opens a WebView and renders markdown bundled into the image at build time.

   
Package com.navotpala.ax86docs
Build Included with --extras
Default doc docs/user-guide/GETTING_STARTED.md (end-user hub; technical pages stay in a second group)

What it shows

At build time, update_docs.sh collects:

  • Every *.md under vendor/ax86-lite (package READMEs, product docs, and so on)
  • Selected external docs from SmartDock DFC and Ethernet Config

Those files are packed into doc_data.js and installed with the app. Pick a document from the dropdown in the app.

Adding docs for a new package

  1. Put a USER_GUIDE.md (end users) and a README.md (developers) in the addon.
  2. Rebuild with --extras so build.sh runs the Ax86Docs update step.
  3. User guides show under Using this device; READMEs under Technical reference.
  4. Mirror the user guide in this repo under User guides.

To pull markdown from outside vendor/ax86-lite, add the path to EXTERNAL_DOCS in vendor_packages/Ax86Docs/update_docs.sh.

End-user walkthroughs live in each addon's USER_GUIDE.md and are also published on this site under User guides.

Public docs vs on-device docs

  Ax86Docs This Documentation site
Where On the device docs.blisscolabs.dev
Source Vendor tree markdown (+ a few AOSP package docs) This git repo
Best for Field / offline reference next to the feature Install, licensing, and the full product guide

Many of the same topics appear in both places. Prefer this site for install and licensing; use Ax86Docs when you are already on the device.