docs/INTEGRATION.md

# Integration with Stock Features

In all supported cars:
* Stock Lane Keep Assist (LKA) and stock ALC are replaced by openpilot ALC, which only functions when openpilot is engaged by the user.
* Stock LDW is replaced by openpilot LDW.

Additionally, on specific supported cars (see ACC column in [supported cars](CARS.md)):
* Stock ACC is replaced by openpilot ACC.
* openpilot FCW operates in addition to stock FCW.

openpilot should preserve all other vehicle's stock features, including, but not limited to: FCW, Automatic Emergency Braking (AEB), auto high-beam, blind spot warning, and side collision warning.
Sphinx docs generation (#22697) * add sphinx * switch theme * Experiment: sphinx docs generation updated (#22708) * moved build to root gitignore, added .gitkeep * Improved makefile doc build process - Removed auto-generated docs from source control - Moved apidoc.sh into Makefile - Removed make.bat (can add back if Windows support desired) - Added sphinx viewcode and markdown extensions - Added feature to source /docs in build, so any .rst file in /docs will override the respective file during the build process - Added feature to copy all markdown/rst files from source into /build/ during build process so they can be easily referenced while writing docs (see examples in index.md) - Wrote basic starter index.md file TODO: Add new dependencies to Pipfile [dev-packages] * Revert accidental modification to Pipfile * fix command substitution * exclude xx * improve docs * dont include all docs in release build * Add dockerfile * update title * include normal readme * build container in CI * use buildkit * add login Co-authored-by: Chad Bailey <chadbailey904@gmail.com> 2021-10-28 15:14:37 +02:00			`# Integration with Stock Features`
Update Docs (#22229) * initial move of docs * more cleanups * more docs * simpler * more docs * link fix * typos * more typos * more info * minor updates 2021-09-14 15:39:31 -07:00
			`In all supported cars:`
			`* Stock Lane Keep Assist (LKA) and stock ALC are replaced by openpilot ALC, which only functions when openpilot is engaged by the user.`
			`* Stock LDW is replaced by openpilot LDW.`

Fixed broken link to supported cars (#22301) Now links to the proper page with ACC column 2021-09-21 17:54:16 -04:00			`Additionally, on specific supported cars (see ACC column in [supported cars](CARS.md)):`
Update Docs (#22229) * initial move of docs * more cleanups * more docs * simpler * more docs * link fix * typos * more typos * more info * minor updates 2021-09-14 15:39:31 -07:00			`* Stock ACC is replaced by openpilot ACC.`
			`* openpilot FCW operates in addition to stock FCW.`

One-word grammar fix to docs/INTEGRATION.md (#26621) Grammar fix 2022-11-29 00:38:18 -08:00			`openpilot should preserve all other vehicle's stock features, including, but not limited to: FCW, Automatic Emergency Braking (AEB), auto high-beam, blind spot warning, and side collision warning.`