> ## Documentation Index
> Fetch the complete documentation index at: https://dragonwingdocs.qualcomm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Documentation conventions

This guide uses the following conventions throughout.

## Commands and code

All shell commands and code samples appear in monospace code blocks.
Run commands exactly as shown unless a placeholder is indicated.
Placeholders use angle-bracket notation and must be replaced with
your actual values.

```text theme={null}
git clone <repo-url> -b <branch>
```

## File paths

Paths are relative to the kernel source root (`kernel-src/`) unless
stated otherwise. Repository-relative paths are shown as-is;
absolute host paths begin with `/`.

## Variables and substitution tokens

Variable names in recipes and configuration files are shown in
`ALL_CAPS`. When a value depends on your SoC or board, the
placeholder follows the pattern `<SoC>`, `<board>`, or `<variant>`.

```text theme={null}
KERNEL_DEVICETREE = "qcom/<SoC>-<board>-<variant>.dtb"
```

## Notes, warnings, and tips

<Note>
  Notes highlight information that is important but does not
  prevent the procedure from completing if overlooked.
</Note>

<Warning>
  Warnings identify actions that may produce unexpected results
  or require extra care.
</Warning>

## Cross-references

Links to other sections in this guide appear as inline hyperlinks.
Links to external documentation also appear as inline hyperlinks.
