Skip to content
This repository has been archived by the owner on May 16, 2024. It is now read-only.

Update repo 'about' and Readme #36

Open
calmrat opened this issue Dec 14, 2022 · 0 comments
Open

Update repo 'about' and Readme #36

calmrat opened this issue Dec 14, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@calmrat
Copy link

calmrat commented Dec 14, 2022

Please add a short description to this repository which describes it's contents to the repository 'about' section.

eg, "Interface definitions of DDC protocols."

Screenshot 2022-12-14 at 10 57 15

Also, please describe in more detail what the schemas are used for, so it's clear without needing to go to the external documentation to understand.

I suppose the answers are here? https://docs.cere.network/ddc/protocols/contract-params-schema?

The readme should provide the first and most accurate high-level description of the repo's contents. I suggest including release notes should be included here too, first; and in the docs, secondarily (if at all), assuming there is a process for ensuring they remain in sync.

Thanks!

@calmrat calmrat added the documentation Improvements or additions to documentation label Dec 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant