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

DOC: Update docs and add template files #57

Merged
merged 3 commits into from
Oct 22, 2024

Conversation

khalford
Copy link
Member

Updated the README.md.

Added documentation about the config.yaml file. This does not yet exist but is a proposed idea. Once I have made the functional changes (changing read methods and tests) then I will put this PR forward for merging.

Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.32%. Comparing base (4885a5a) to head (fd2f3b7).
Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #57   +/-   ##
=======================================
  Coverage   96.32%   96.32%           
=======================================
  Files          12       12           
  Lines         571      571           
=======================================
  Hits          550      550           
  Misses         21       21           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@khalford
Copy link
Member Author

Will be taken out of draft once #58 is merged

Copy link
Contributor

@Dmitry-Popovichev Dmitry-Popovichev left a comment

Choose a reason for hiding this comment

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

All looks great, the format works well and is easy to read, just had the one small comment about one of the links.

cloud-chatops/README.md Show resolved Hide resolved
Copy link
Collaborator

@DavidFair DavidFair left a comment

Choose a reason for hiding this comment

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

Some nit picks around readability
Otherwise really good improvement and explanation of the repo

cloud-chatops/README.md Outdated Show resolved Hide resolved
cloud-chatops/README.md Outdated Show resolved Hide resolved
cloud-chatops/README.md Outdated Show resolved Hide resolved
cloud-chatops/README.md Show resolved Hide resolved
@Dmitry-Popovichev Dmitry-Popovichev merged commit 9e6bbae into master Oct 22, 2024
8 checks passed
@Dmitry-Popovichev Dmitry-Popovichev deleted the cloud-chatops-docs branch October 22, 2024 12:26
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.

3 participants