Personal opinion: Wouldn't it be better if the reference documentation was generated from the code directly? This would avoid it getting out of date and having to maintain these docs + the test for the docs. The examples should probably moved to how-to guides to follow https://diataxis.fr/.
Personal opinion: Wouldn't it be better if the reference documentation was generated from the code directly? This would avoid it getting out of date and having to maintain these docs + the test for the docs. The examples should probably moved to how-to guides to follow https:/ /diataxis. fr/.