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

docs(overhaul): provide a very detailed documentation for the options #456

Merged
merged 43 commits into from
May 25, 2021

Conversation

C0ZEN
Copy link
Contributor

@C0ZEN C0ZEN commented May 23, 2021

Changes

  • Simplify the table of options to keep it readable
  • Provide an entry for each option of this project
  • Changed the default value to empty for remove-issue-stale-when-updated and remove-pr-stale-when-updated else remove-stale-when-updated is useless

Closes #362

C0ZEN added 22 commits May 22, 2021 23:55
@C0ZEN C0ZEN marked this pull request as ready for review May 23, 2021 11:04
@C0ZEN C0ZEN requested a review from a team as a code owner May 23, 2021 11:04
@C0ZEN
Copy link
Contributor Author

C0ZEN commented May 23, 2021

@HonkingGoose I know you like to review the wording, so you are well served here ;)
@hross @luketomlinson WDYT?

@C0ZEN
Copy link
Contributor Author

C0ZEN commented May 23, 2021

Closes #450

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
C0ZEN and others added 2 commits May 23, 2021 14:23
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
C0ZEN and others added 15 commits May 23, 2021 14:24
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@C0ZEN
Copy link
Contributor Author

C0ZEN commented May 23, 2021

@HonkingGoose thanks!

@HonkingGoose
Copy link
Contributor

@HonkingGoose thanks!

You're welcome!

I'll let the other reviewers do their work now. 😉

README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@luketomlinson luketomlinson left a comment

Choose a reason for hiding this comment

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

1 minor nitpick, @C0ZEN. But otherwise looks good. Huge improvement!

@C0ZEN
Copy link
Contributor Author

C0ZEN commented May 25, 2021

Nice catch!

Copy link
Collaborator

@luketomlinson luketomlinson left a comment

Choose a reason for hiding this comment

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

Great work @C0ZEN!

@luketomlinson luketomlinson merged commit 16dfaa2 into actions:main May 25, 2021
@C0ZEN C0ZEN deleted the feature/docs branch May 25, 2021 17:52
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.

Split the doc in half: a table of options and a list of detailed options
3 participants