Developer Documentation Is Difficult to Follow
Closed this issue · 0 comments
seanmalloy commented
What version of git2consul-go are you using?
$ git2consul -version git2consul, version v0.1.1 (branch: HEAD, revision: abdf3a1d746539f08ce5122f9d7db43ae4e79afd) build date: 20200106-19:50:06 go version: go1.13.5
Does this issue reproduce with the latest release?
Yes
What operating system and processor architecture are you using (uname -a)?
uname -a Output
$ uname -a Darwin 17.7.0 Darwin Kernel Version 17.7.0: Sun Dec 1 19:19:56 PST 2019; root:xnu-4570.71.63~1/RELEASE_X86_64 x86_64 i386 MacBookPro11,4 Darwin
What did you do?
I tried to follow the contributing/development docs.
What did you expect to see?
An easy to follow guide to getting started developing git2consul. The doc should make it easy for contributors on onboard.
What did you see instead?
I noticed that the docs are incomplete and spread across multiple files. The docs are hard to follow.