Skip to content

Front and centre a code example on hegel.dev #12

@DRMacIver

Description

@DRMacIver

https://lobste.rs/s/juc8ix/hegel_universal_property_based_testing#c_0frbno

Let me be that person: please put a "hello world" example for complete noobs straight on your initial landing page. I have no idea what "property-based testing" is, I only heard this name a few times, but don't know how it works at all. I have no idea if that hegel thing is of any use to me until I can understand what's this PBT thing it assumes I already know, or the Hypothesis thing it also assumes I already know. It took me a few good minutes to finally find the following:

https://github.com/hegeldev/hegel-rust#quickstart

This one is short and clear enough for me to grasp some basic understanding of the core idea. Please put the contents of that quickstart straight on the main hegel.dev page.

It's a good suggestion and we should both have a code example (ideally localisable to each language) and also one or two sentences about what property based testing is on the front page, for people who arrive at it there rather than from one of the github pages or from the article.

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentwording and content on existing pages

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions