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.

Sign up for GitHub

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

Jump to bottom

hemictl: improve readme docs #366

Merged
merged 3 commits into from
Jan 28, 2025
Merged

hemictl: improve readme docs #366

merged 3 commits into from
Jan 28, 2025

Conversation

crStiv
Copy link
Contributor

@crStiv crStiv commented Jan 9, 2025

  • Add missing environment variables documentation
  • Improve code examples and formatting
  • Add error handling section
  • Reorganize content with clear sections
  • Add usage notes and best practices
  • Remove sensitive information

@crStiv
Update README.md
d003c22 
- Add missing environment variables documentation
- Improve code examples and formatting
- Add error handling section
- Reorganize content with clear sections
- Add usage notes and best practices
- Remove sensitive information
@crStiv crStiv requested a review from a team as a code owner January 9, 2025 19:42
@github-actions github-actions bot added the area: hemictl This is a change to hemictl label Jan 9, 2025
marcopeereboom
marcopeereboom requested changes Jan 14, 2025
View reviewed changes
Copy link
Contributor

@marcopeereboom marcopeereboom left a comment

Choose a reason for hiding this comment

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

Do not unindent JSON.

@crStiv
Copy link
Contributor Author

crStiv commented Jan 14, 2025

Do not unindent JSON.

@marcopeereboom sure thing, did it! like this?

@joshuasing joshuasing changed the title docs: improve hemictl documentation and organization hemictl: improve readme docs Jan 16, 2025
joshuasing
joshuasing requested changes Jan 20, 2025
View reviewed changes
@joshuasing
Copy link
Contributor

Thank you!

@joshuasing joshuasing merged commit 25a8062 into hemilabs:main Jan 28, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcopeereboom marcopeereboom marcopeereboom approved these changes

@joshuasing joshuasing joshuasing approved these changes

Assignees
No one assigned
Labels
area: hemictl This is a change to hemictl
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@crStiv @joshuasing @marcopeereboom