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

Add Detailed HashiCAT Documentation #60

Open
BeenzSyed opened this issue Jul 9, 2021 · 1 comment
Open

Add Detailed HashiCAT Documentation #60

BeenzSyed opened this issue Jul 9, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@BeenzSyed
Copy link

It would be great to have detailed documentation about HashiCAT, what it does and how it works.

This could be somewhat along the lines of the Raft documentation (idea by @findkim). Maybe not as detailed at the start but something that can help others who are new to the project understand it more easily.

@BeenzSyed BeenzSyed added the documentation Improvements or additions to documentation label Jul 9, 2021
@eikenb
Copy link
Contributor

eikenb commented Jul 9, 2021

Thanks for taking the time to file this issue @BeenzSyed!

The current plan is to focus on the generated godocs for documentation, with a particular focus on examples. Thought a separate overview/intro type page might also be good with pointers to the repo and the godocs at some point.

The raft site is more about the raft algorithm than about our raft library, so I'm not sure it makes for a good example to follow in this case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants