📝 Add comments to configuration files

Author: nelson6e65

docs/.vuepress/config.js

@@ -4,7 +4,7 @@ module.exports = {
   base: '/phpdoc-vuepress/',
 
   title: 'phpdoc-vuepress',
-  description: 'VuePress template for phpDocumentor',
+  description: 'Template for generating your PHP API documentation in a pretty VuePress format',
   ga: 'UA-58599811-1',
 
   markdown: {
@@ -14,33 +14,37 @@ module.exports = {
 
   themeConfig: {
     nav: [
-      { text: 'Guide', link: '/guide/' },
-      { text: 'Demo', link: '/demo/' },
+      { text: 'Guide', link: '/guide/' }, // Normal documentation link
+      { text: 'Demo', link: '/demo/' }, // Your api documentation link
     ],
 
     sidebar: {
-      '/guide/': [
+      '/guide/': [ // Normal documentation
         {
           title: 'Guide',
           collapsable: false,
-          children: [
+          children: [ // Normal pages
             '',
             'getting-started',
             'configuration',
           ]
         }
       ],
+
+      // Your API documentation
+      // Here is where will be generated your files (`docs/demo/` in this case).
+      // (This directory should be ignored by Git)
       '/demo/': [
         {
-          title: 'Demo',
+          title: 'Demo', // Title of your API documentation
           collapsable: false,
           children: [
-            '',
-            'classes',
-            'interfaces',
-            'traits',
-            'functions',
-            'constants'
+            '', // Ref. to the `README.md` file
+            'classes', // Ref. to the `classes.md` file
+            'interfaces', // Ref. to the `interfaces.md` file
+            'traits', // Ref. to the `traits.md` file
+            'functions', // Ref. to the `functions.md` file
+            'constants' // Ref. to the `constants.md` file
           ]
         }
       ],

phpdoc.dist.xml

@@ -1,21 +1,29 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <phpdoc>
+  <!-- Title of your project. It will be used to show a mini description -->
   <title>`phpdoc-vuepress` demo</title>
 
   <parser>
     <visibility>public,protected</visibility>
-    <target>build/api-cache</target>
+    <target>build/api-cache</target> <!-- This can be set to any directory (remember ignore it by Git) -->
   </parser>
 
   <transformer>
+    <!-- This is the directory where the generated files will be. -->
+    <!-- Set it according to your VuePress config  -->
     <target>docs/demo</target>
   </transformer>
 
   <transformations>
-    <template name="data/templates/vuepress" />
+    <!-- This is the directory where the template is. -->
+    <template name="data/templates/vuepress" /> <!-- In this case, the template.xml file is in that directory-->
+
+    <!-- By default, should be set to: "vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress" -->
+    <!-- <template name="vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress" /> -->
   </transformations>
 
   <files>
+    <!-- This is the directory that will be extracted the documentation. In this case. `demo/` -->
     <directory>demo</directory>
   </files>