re-organize model/engine documentation #422
Description
I feel like there are two issues that make the current documentation less effective:
- Model help packages become very long since we document all of the engines there. Since it throws a lot of information at the user, it is more difficult to find information and they might not read it at all.
- We need a way to reference documentation of engines that are provided by other packages. For example,
multilevelmodhas engines forlinear_reg()and other models. The user might not be able to find those engine-specific notes.
The clock documentation is nicely organized by having a main page for a generic and sub-pages for the specific methods. For example, the getter functions show the generic methods and there are clear links at the top of the page that show the information for different types of calendars.
To solve the first problem listed above, we could make rd files for model/engine combinations and link those at the top of the model page.
For the issue with parsnip-adjacent packages, the parsnip model pages could also use dynamic documentation to make that list of links at the top (depending on what is available/attached at the moment). This would be similar to how generics shows a list of methods dynamically.