Closed
Conversation
yanick
reviewed
Jun 8, 2025
yanick
reviewed
Jun 8, 2025
yanick
reviewed
Jun 8, 2025
yanick
reviewed
Jun 8, 2025
yanick
requested changes
Jun 12, 2025
Contributor
yanick
left a comment
yanick
left a comment
There was a problem hiding this comment.
There is my comments here, and the PR for the example, but it looks good! \o/
Contributor
Author
|
@yanick Thanks for the PR. Changes are addressed, please take a quick pass and 👍 if you're good with everything, Anyone else who would like to review before this gets merged, please do! |
Some minor cleanup, and the start of some better structure to the core of the manual.
This iteration uses a simple question and answer format to help users both new and old find the correct answers to the questions they have.
We have discouraged the use of the dance keyword for some time; our most basic example should not feature it.
Right now, this is just the installation instructions ripped from the manual, with notes on what else to do.
Next up: introducing core concepts through the Danceyland example.
All of these items are subsections of the manual, and as such, should be namespaced properly.
This info belongs in the Deployment section of the manual; having it in the core of the manual doesn't make sense.
Originally we were using sessions to pass messages between routes across requests. Removing that as I don't think it adds much to the tutorial; I think dealing with sessions in the context of authentication is good enough.
Keywords are linked back to where they appear in the Dancer2 manual, and keywords link to related keywords within the keyword document.
... it was expecting `user` to be a query parameter, whereas the example has it as a route param.
cromedome
force-pushed
the
docs/doc-grant-release
branch
from
fda5926 to
c4f8eda
Compare
This was referenced Jul 23, 2025
Contributor
Author
cromedome
added a commit
that referenced
this pull request
Sep 15, 2025
[ BUG FIXES ]
* GH #1701: Split cookie values on & only (Yanick Champoux)
[ ENHANCEMENTS ]
* GH #530: Make data censoring configurable (Yanick Champoux, David
Precious)
* GH #850: Scaffold tutorial app; allow multiple apps to be scaffolded
in core Dancer2 (Jason A. Crome)
* GH #1512: Log hook entries as they are executed (Yanick Champoux)
* GH #1615: Remove Dancer2::Template::Simple from Dancer2 core (Jason
A. Crome)
* PR #1637: New, extendable configuration system (Mikko Koivunalho)
* GH #1723: Enable use of a different Template Toolkit base class
(Andy Beverley)
* PR #1727: Don't create CPAN package files when generating new apps
(Jason A. Crome)
* PR #1731: Retire Template::Tiny fork, use CPAN's (Jason A. Crome,
Karen Etheridge, Damien Krotkine, Yanick Champoux)
* PR #1736: Allow config system to bootstrap itself (Yanick Champoux)
* GH #1737: Add on_hook_exception for errors during hook processing
(Andy Beverley)
* PR #1739: Add source to on_hook_exception (Andy Beverley)
* PR #1742: Refactor CLI for future expansion (Jason A. Crome)
[ DOCUMENTATION ]
* GH #1342: Document skipping private methods in pod coverage tests
(Jason A. Crome)
* PR #1721: New Dancer2 docs, reorganization of all documentation;
from TPRF grant (Jason A. Crome)
* PR #1741: Cover items missed in earlier documentation branch (Jason
A. Crome)
[ DEPRECATED ]
* None
[ MISC ]
* None
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This is the result of a TPRF grant for rewriting the Dancer2 documentation. Highlights include:
Dancer2::Manual)Dancer2::Manual::namespaceThis list is non-exhaustive. I relentlessly cut content out from the old manual; some of it outdated, some of it unnecessary. Hopefully I didn't get too overly aggressive.
I squashed about 40 commits already. If anyone would like me to squash this further, just say the word.
Thanks to Sawyer for being my grant manager on this!