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.

Sign up for GitHub

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

Jump to bottom

Populate READMEs with relevant documentation #2

Open
krebernisak opened this issue Dec 29, 2021 · 0 comments
Open

Populate READMEs with relevant documentation #2

krebernisak opened this issue Dec 29, 2021 · 0 comments

Comments

@krebernisak
Copy link
Collaborator

A lot of documentation is currently missing from the repository.

We should consider adding substantial documentation under ./docs but also populate README.md files for the repo itself and other important subdirectories.

The documentation should enable users to better understand the codebase, but also provide step-by-step tutorials on how to set up the system and run it e2e.
@aalu1418 aalu1418 transferred this issue from another repository Jan 3, 2022
RyanRHall pushed a commit that referenced this issue Jan 3, 2022
@krebernisak
Codebase cleanup & polish #2
d817e34
krebernisak added a commit that referenced this issue Feb 16, 2022
@krebernisak
Merge pull request #127 from smartcontractkit/develop
97f5b57 
Release v0.1.0 (contracts version) take #2
krebernisak added a commit that referenced this issue Mar 9, 2022
@krebernisak
Merge pull request #201 from smartcontractkit/develop
43f3aa5 
Release v0.1.5 (contracts version) #2
archseer added a commit that referenced this issue Apr 20, 2022
@archseer
Merge pull request #255 from smartcontractkit/develop
b2dde6d 
Release contracts v1.0 (#2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@krebernisak