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

Documentation revamp #443

Merged
merged 9 commits into from
Dec 26, 2022
Merged

Documentation revamp #443

merged 9 commits into from
Dec 26, 2022

Conversation

alejandrohdezma
Copy link
Member

@alejandrohdezma alejandrohdezma commented Dec 21, 2022

💻 How to review this PR?

This PR was created with the idea of being reviewed commit by commit. Each commit contains an incremental change that makes it easier to review. Also some of the commits contain additional information in their description to help understand why the change was made.

I also recommend checking "Hide whitespace" when reviewing this PR!

📘 Complete documentation revamp

  • Add more documentation to action.yml.
  • Complete reword of README.md, making it more usable and easier to follow/navigate.
  • Update guides in README.md to follow latest updates to the action.
  • Add mechanisms to ensure the TOC and the list of inputs in README.md is kept up-to-date.

You can check the new README here.

@alejandrohdezma alejandrohdezma added the documentation Improvements or additions to documentation label Dec 21, 2022
github-actions bot added a commit that referenced this pull request Dec 21, 2022
github-actions bot added a commit that referenced this pull request Dec 21, 2022
@alejandrohdezma
Copy link
Member Author

@anatoliykmetyuk would love your input here, since you were the last one updating the docs 😸

github-actions bot added a commit that referenced this pull request Dec 21, 2022
@github-actions
Copy link
Contributor

Code Coverage

Package Line Rate Branch Rate Complexity Health
core 100% 100% 0
modules 64% 87% 0
Summary 65% (460 / 703) 88% (76 / 86) 0

@github-actions
Copy link
Contributor

A snapshot release has been created as snapshots/443.

You can test it out with:

uses: scala-steward-org/scala-steward-action@snapshots/443

It will be automatically recreated on any change to this PR.

github-actions bot added a commit that referenced this pull request Dec 21, 2022
@scala-steward-org scala-steward-org deleted a comment from github-actions bot Dec 21, 2022
@alejandrohdezma alejandrohdezma merged commit 9ecdc7f into master Dec 26, 2022
@alejandrohdezma alejandrohdezma deleted the docs/revamp branch December 26, 2022 10:07
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.

1 participant