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

Update documentation #35

Merged
merged 1 commit into from
Feb 24, 2021
Merged

Update documentation #35

merged 1 commit into from
Feb 24, 2021

Conversation

tcnksm
Copy link
Contributor

@tcnksm tcnksm commented Feb 18, 2021

WHAT

Update documentation

  • Move hcledit command related documentation into cmd/hcledit directory
  • Have same example both package and CLI

WHY

I'm thinking the main content of this repository is hcledit package itself and CLI is one application based on it. So I want to separate doc for each and make it clear.

@@ -0,0 +1,112 @@
# hcledit command
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[IMO] How about hcledit(1)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm ok with naming like that. But I think just saying "command" is more clear for most people?

@tcnksm tcnksm merged commit cea0d0e into main Feb 24, 2021
@tcnksm tcnksm deleted the feature/documentation branch August 16, 2021 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants