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

PROGRAMS.md added #110

Merged
merged 10 commits into from
Dec 10, 2024
Merged

PROGRAMS.md added #110

merged 10 commits into from
Dec 10, 2024

Conversation

sadrasabouri
Copy link
Collaborator

Reference Issues/PRs

#100

What does this implement/fix? Explain your changes. [Genrated by Copilot AI - GitHub 👍 ]

This pull request includes several updates to documentation files, including the addition of a new overview of breathing programs and modifications to existing files. The most important changes are summarized below:

Documentation updates:

  • PROGRAMS.md: Added a comprehensive overview of Nafas breathing programs, detailing each program's description, level, ratios, unit, and cycles. This addition provides users with a clear understanding of the available programs and their benefits.
  • README.md: Updated to include a link to the newly added PROGRAMS.md for users to easily access the list of available programs. This change enhances the usability of the README by directing users to more detailed information.

Changelog update:

  • CHANGELOG.md: Modified to reflect the changes made to README.md, ensuring that the changelog is up-to-date with the latest documentation updates.

@sadrasabouri sadrasabouri added the documentation Improvements or additions to documentation label Nov 28, 2024
@sadrasabouri sadrasabouri added this to the nafas v0.9 milestone Nov 28, 2024
@sadrasabouri sadrasabouri self-assigned this Nov 28, 2024
Copy link

codecov bot commented Nov 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.81%. Comparing base (0088af9) to head (40535d2).
Report is 1 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #110   +/-   ##
=======================================
  Coverage   96.81%   96.81%           
=======================================
  Files           2        2           
  Lines         219      219           
  Branches       24       24           
=======================================
  Hits          212      212           
  Misses          5        5           
  Partials        2        2           

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

CHANGELOG.md Show resolved Hide resolved
PROGRAMS.md Outdated
@@ -0,0 +1,20 @@
# Overview of Nafas Breathing Programs
Copy link
Owner

Choose a reason for hiding this comment

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

Overview of Nafas Breathing Programs

PROGRAMS.md Show resolved Hide resolved
PROGRAMS.md Outdated
@@ -0,0 +1,20 @@
# Overview of Nafas Breathing Programs

| **Program** | **Description** | **Level** | **Ratios**<br>**(I:R:E:S)** | **Unit**<br>**(Minutes)** | **Cycles** |
Copy link
Owner

Choose a reason for hiding this comment

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

**Unit**<br>**(Seconds)**

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@KuzyXD
Copy link

KuzyXD commented Dec 9, 2024

It will be nice if you also explain what is 'sustain' and 'retain' means. I'm foreigner and many MTL translate this as the same

Copy link
Owner

@sepandhaghighi sepandhaghighi left a comment

Choose a reason for hiding this comment

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

🔥

@sepandhaghighi
Copy link
Owner

It will be nice if you also explain what is 'sustain' and 'retain' means. I'm foreigner and many MTL translate this as the same

@KuzyXD
Thank you for your comment. You are correct; we will include it in a future PR.💯

@sepandhaghighi sepandhaghighi merged commit f14443d into dev Dec 10, 2024
27 checks passed
@sepandhaghighi sepandhaghighi deleted the programs-doc branch December 10, 2024 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants