You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We want there to be documentation around the larger pieces of the application to help give context to how the application is generally structured to outside contributors. We understand that docs that are too in depth or are focused on the more technical complexity of certain parts of the application may become a maintenance burden over time as those items are updated. We would like to stick to higher level explainations of the larger aspects of the application and how they play a role in the system.
Here are some of the topics I feel we should document off the top of my head in no particular order. Feel free to suggest additional topics to discuss and how deeply we should document them.
We have three top level user interfaces: CLI fetch, HTTP API via daemon, and programmatic library use
How candidates are found
We think about the retrieval process in phases
There are implementations of retrievers that do the actual work of retrieval based on the protocol being used
We emit events from each step of the retrieval process
The text was updated successfully, but these errors were encountered:
We want there to be documentation around the larger pieces of the application to help give context to how the application is generally structured to outside contributors. We understand that docs that are too in depth or are focused on the more technical complexity of certain parts of the application may become a maintenance burden over time as those items are updated. We would like to stick to higher level explainations of the larger aspects of the application and how they play a role in the system.
Here are some of the topics I feel we should document off the top of my head in no particular order. Feel free to suggest additional topics to discuss and how deeply we should document them.
fetch
, HTTP API viadaemon
, and programmatic library useThe text was updated successfully, but these errors were encountered: