fastai / fastcore

Python supercharged for the fastai library
http://fastcore.fast.ai
Apache License 2.0
954 stars 274 forks source link

Feedback: First example in documentation should showcase the library #579

Open JelleZijlstra opened 1 month ago

JelleZijlstra commented 1 month ago

I looked at https://fastcore.fast.ai/docments.html, glanced at the text, then focused on the first example. But then I noticed that the example is actually not of what docments does, it's an example of what it replaces.

I'm sure I'm not the only one who focuses on examples when first looking at documentation. I think your documentation landing page would do a better job of showcasing the feature if it started with an example of how you'd use docments, not of what the alternative is.