Merge pull request #11 from zxzxwu/docs

Add some docs

Author: zxzxwu

docs/common_errors_and_failures.md

@@ -0,0 +1,31 @@
+# Common Errors and Failures
+
+This page records the known common failures.
+
+## General
+
+### Test Cases are skipped
+
+* Caused by: `Intended Behavior`
+
+Expected. Before running tests, we check if DUT supports corresponding features by system property.
+
+### TransportLostLost
+
+* Caused by: `REF device`
+
+Please check your USB connection, or take a bug report and see why the connection between Bumble and Controller is lost.
+
+## Venti
+
+### LePairingTest.test_legacy_pairing
+
+* Caused by: `Android Bluetooth Stack`
+
+Some legacy test cases cannot pass on Android releases before 25Q4 or equivalent mainline modules.
+
+### LePairingTest.test_oob_pairing
+
+* Caused by: `Android Bluetooth Stack`
+
+Legacy OOB pairing has known failure on Android releases around 2025.

docs/index.md

@@ -1 +1,19 @@
 # Home
+
+This is a Bluetooth testing suite originally made for Pixel devices, but released for Android partners to evaluate their Bluetooth and Audio implementation.
+
+## Suites
+
+There are 3 predefined suites in the package:
+
+1. Smoke (`python -m smoke` or `mobly_runner smoke`)
+
+    A suite that all cases are expected to pass.
+
+2. Venti (`python -m venti` or `mobly_runner venti`)
+
+    A suite that allows some cases failed, or requiring more reference devices to run.
+
+3. All (`python -m run_all` or `mobly_runner run_all`)
+
+    All test cases.

docs/user_params.md

@@ -0,0 +1,53 @@
+# User Params
+
+In config.yml, some user params are used by Navi for particular purposes.
+
+## max_retry_count
+
+Type: integer
+
+The max retry count applied to all test cases.
+
+Note: If test cases are already decorated with `retry()`, it will select the larger retry count among decorators and user params.
+
+## device_serials
+
+Type: string
+
+A list of device serial numbers separated with comma. When present, test devices will be allocated based on the given order, instead of order provided by config or adb.
+
+Example: `001,002,003`
+
+## crown_driver
+
+Type: one of `android`, `passthrough`, `cf_rootcanal`, default is `android`
+
+The type of Crown (REF) driver.
+
+* `android`: Running HCI Proxy on Android device.
+* `passthrough`: Use raw Bumble transports (require `crown_driver_specs`).
+* `cf_rootcanal`: Request Rootcanal ports from Cuttlefish emulators.
+
+## crown_driver_specs
+
+Type: list or comma-separated list string
+
+A list of bumble transport specs. REF Bumble devices will run above them.
+
+Example: `["tcp-client:127.0.0.1:7300", "tcp-client:127.0.0.1:7300"]`
+
+## record_full_data
+
+Type: boolean, default is False
+
+Whether full log data will be recorded no matter passed or not, including:
+
+* Bugreports on pass
+* Snoop logs and dumpsys on pass
+* Recorded audio data
+
+## dump_crown_log_on_fail
+
+Type: boolean, default is False
+
+Whether to dump crown log on fail for debugging.