Skip to content

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

@JelleZijlstra

Description

@JelleZijlstra

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions