Skip to content
This repository has been archived by the owner on Apr 27, 2019. It is now read-only.

Write better docs #44

Open
highlyunavailable opened this issue Mar 3, 2016 · 3 comments
Open

Write better docs #44

highlyunavailable opened this issue Mar 3, 2016 · 3 comments

Comments

@highlyunavailable
Copy link
Contributor

Write docs about how to, from a C# perspective

  • Construct and use the ConsulClient class
  • Do blocking queries/"watches"
  • Wrap distributed locks around critical sections
  • Use query metadata
@egarson
Copy link

egarson commented Mar 7, 2016

Hello
While I support light documentation, I suggest using tests as a form of executable documentation. You can even combine the two, by providing How To's in docs with links to relevant tests.
Just a thought.
I will try what you suggest in [https://github.com//issues/43#event-578638951](Issue #43 Support for Other Watch Types) later today if I find the time.
Kind regards

@highlyunavailable
Copy link
Contributor Author

That's a good idea as well. I do need to clean up the tests and get them working for monodevelop.

@giokoguashvili
Copy link

@highlyunavailable what about ACL support, I can't find docs and code samples.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants