AnswerDotAI / AnswerDotAI/fastcore
Feedback: First example in documentation should showcase the library
- Dominant language
- Jupyter Notebook
- Stars
- 1.1k
- Forks
- 295
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 7
Description
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.
Contributor guide
Research direction
Start at https://fastcore.fast.ai/docments.html and inspect the first example and the surrounding documentation. Reorder or replace the opening example so it demonstrates how docments is used, while keeping the page's explanation of what it replaces; done means the landing page showcases the library immediately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100