Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
JelleZijlstra opened this issue Jul 12, 2024 · 0 comments
Open

Comments

@JelleZijlstra
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant