Improve GitHub documentation #1711
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changing case will allow this to show up as a tab on the GitHub landing page for Dancer2.
This will show up in a separate tab on the landing page for Dancer2.
This will show up as a separate tab in the GitHub interface on the Dancer2 landing page.
As we're adding some styling and customization to the README, we don't want to overwrite it with the main module pod when we release a new version.
This will show up as a separate tab in the GitHub interface for Dancer2.
This will no longer be autogenerated at release time, and has been updated to look nice on GitHub.
Removed some redundancies, improved some of the language, and generally tried to make it read less like a Pod document and more like a welcoming guide to Dancer2.
GeekRuthie
approved these changes
Jun 22, 2024
yanick
approved these changes
Jun 24, 2024
Comment on lines
+22
to
+24
| Dancer2 is the evolution of [Dancer](https://metacpan.org/pod/Dancer) | ||
| which is based on on [Moo](https://metacpan.org/pod/Moo), a lightweight | ||
| object framework for Perl. |
There was a problem hiding this comment.
The original 'which' makes me parse that Dancer1 is based on Moo.
Suggested change
| Dancer2 is the evolution of [Dancer](https://metacpan.org/pod/Dancer) | |
| which is based on on [Moo](https://metacpan.org/pod/Moo), a lightweight | |
| object framework for Perl. | |
| Dancer2 is the evolution of [Dancer](https://metacpan.org/pod/Dancer) | |
| and is based on on [Moo](https://metacpan.org/pod/Moo), a lightweight | |
| object framework for Perl. |
|
Thanks for the feedback! Incorporated and merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To go along with Dancer2 1.x, we should have a more modern and welcoming landing page on GitHub. The core of this is still derived from the Dancer2 Pod, but is written to be prettier and more welcoming. This README is our chance to make a good first impression, and this attempts to make it a much better impression.
Suggestions and feedback are welcome and needed.