hashicorp / hashicorp/syntax

Decouple Readme based on use cases

Open
#14 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
HCL
Stars
31
Forks
12
Avg merge
7m
Merged PRs (30d)
1

Description

I'm not tied to filenames, but from your response we appear to be in agreement that this README should be a landing page and not a catalogue of all the different sets of knowledge required to use the files in this repo.

Extrapolating from your thoughts, I think we need:

- README.md with sections briefly explaining the repo and the different types of uses cases. Each with links to get users/contributors where they need to go.
- USAGE.md document outlining expected ways to consume these files
- CONTRIBUTING.md document outlining what content we accept.

_Originally posted by @jpogran in https://github.com/hashicorp/syntax/pull/11#discussion_r823770761_

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.