doc/dev: add API docs architecture docs
Created by: slimsag
Add basic API docs architecture docs, and explain tradeoffs we've made so far.
This doc will be used to explain API docs search indexing tradeoffs in an upcoming PR.
Helps #21938
Signed-off-by: Stephen Gutekanst [email protected]