cursorless/docs/contributing/_api-index.md
Pokey Rule b7946d9450
Minor Cursorless docs follow-up tweaks (#610)
* Have a bit more exposition and point to API doc landing page on contributing landing page.
Fixes #609

* Test broken link

* Fail on docs build fail

* Remove broken link

* Various stuff

* Remove unnecessary markdown link checker

* Fix link

* More docs cleanup

* Tweak deploy setup
2022-03-18 10:58:00 +00:00

11 lines
506 B
Markdown

# Cursorless internals
This document is intended to present a high-level overview of the Cursorless
architecture, as well as key pointers to locations in the code base to help
contributors get up to speed.
For the time being, we recommend watching the [internals walk-through
videos](https://youtube.com/playlist?list=PLkafpFOBVedScHi0dy_80DsHwnZIOSOTy)
and having a look through the API docs, starting from the [`runCommand`
function](classes/core_commandRunner_CommandRunner.CommandRunner#runcommand).