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

document the duvet usage in h3 #131

Merged
merged 6 commits into from
Dec 6, 2022
Merged

Conversation

Ruben2424
Copy link
Contributor

Hi,
i have documented the duvet usage.
I hope that all i wrote is correct.

@eagr
Copy link
Member

eagr commented Sep 15, 2022

duvet is still under active development and the interface may change soon, as you could see here in the duvet-specification. Maybe we could keep this open and wait until the duvet 0.2 is out and link to the reference instead.

Also, it may be better to go into some Contribute section, along with a reminder of updating the annotations when behavior has changed.

@seanmonstar
Copy link
Member

@eagr it's been a couple months, does it still seem like something that is going to change soon, or should we just merge Ruben's work here?

@eagr
Copy link
Member

eagr commented Dec 1, 2022

duvet has released a 0.2 but sadly the docs haven't landed, so we can't link to it yet. And the documentation pr seems a bit stagnant. Let's just do this.

Mind moving the docs into a CONTRIBUTING.md and refer to it from the README so that it can be more discoverable and less likely to be skipped by people? @Ruben2424

@Ruben2424
Copy link
Contributor Author

@eagr I renamed it.

CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Julian Eager <[email protected]>
@Ruben2424 Ruben2424 merged commit e7e6199 into hyperium:master Dec 6, 2022
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

Successfully merging this pull request may close these issues.

3 participants