hashicorp / hashicorp/hcat

Add Detailed HashiCAT Documentation

Open
#60 1 comment 1 reaction 0 assignees View on GitHub
documentation
Dominant language
Go
Stars
96
Forks
13
PR merge metrics
No merged PRs in 30d

Description

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](https://raft.github.io/) (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.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the repository's existing documentation and implementation to understand HashiCAT's purpose and behavior. Document what HashiCAT does and how it works in a beginner-friendly form, using the linked Raft documentation as a reference for structure; done means the project is substantially easier for newcomers to understand.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.