In your inference project example, what examples do you place in Getting Started vs common usage examples? In general, where is the best place for usage examples - alongside the methods they use, or in an independent section?
Good question! Getting Started is where I put the information someone needs to know to get started. This is based on two things:
1. The minimum amount of information someone needs to use a project. In this case, that is the "what is", and showing how to run fine-tuned models.
2. Generally useful information that someone can use to evaluate / understand the project. In this case, supported devices.
A reader could skip these if they know for what they are looking, but if someone is new to the project a Getting Started section equips them with what they need.
For Python packages generally, I like to include an abridged version of functionality in a quickstart / Getting Started section. Then, usage examples can have either their own page, or examples with example outputs that are in the code and are propagated up through automated docs. [1] [2]
For small packages, I usually fit all of it in a README; having a strong quickstart, in all cases, is essential. [3]
