Merge branch 'docs/dot-dancer-file'

PerlDancer · Aug 11, 2023 · e32dfde · e32dfde
2 parents 8eebd2b + 65c08bb
commit e32dfde
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/Changes b/Changes
@@ -11,6 +11,7 @@
     * PR #1682: Bump minimum version of Perl to 5.14 (Jason A. Crome)
 
     [ DOCUMENTATION ]
+    * GH #1580: Document the purpose of the .dancer file (Jason A. Crome)
     * GH #1669: Show correct usage of Dancer2::Core::Error (GeekRuthie)
     * GH #1674: Fix POD for input_handle() (mauke)
     * GH #1414: Add documentation resources to the doc map (Jason A.

diff --git a/lib/Dancer2/Manual.pod b/lib/Dancer2/Manual.pod
@@ -86,7 +86,11 @@ It creates a directory named after the name of the app, along with a
 configuration file, a views directory (where your templates and layouts
 will live), an environments directory (where environment-specific
 settings live), a module containing the actual guts of your application, and
-a script to start it. A default skeleton is used to bootstrap the new
+a script to start it. Finally, F<.dancer> indicates the root directory of
+your app, making it easier for Dancer2 to determine the various paths it
+needs for finding resources and code within your application.
+
+A default skeleton is used to bootstrap the new
 application, but you can use the C<-s> option to provide another skeleton.
 For example: