additional documentation clarify

apache · Oct 12, 2023 · ce9118f · ce9118f
1 parent 687d3f6
commit ce9118f
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -359,6 +359,11 @@ sbt -Dpekko.genjavadoc.enabled=true Javaunidoc/doc
 
 Which will generate JavaDoc style docs in `./target/javaunidoc/index.html`. This requires a JDK version 11 or later.
 
+#### Changing the project information page index
+
+In case you want to change the index of `Project Information` page, you need to change it on the
+`project/ProjectIndexGenerator.scala` so it can be included in the automatic docs generation.
+
 ### External dependencies
 
 All the external runtime dependencies for the project, including transitive dependencies, must have an open source license that is equal to, or compatible with, [Apache 2](https://www.apache.org/licenses/LICENSE-2.0).

diff --git a/docs/src/main/paradox/project/project-index.md b/docs/src/main/paradox/project/project-index.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT DIRECTLY: This file is generated by `project/ProjectIndexGenerator`. See CONTRIBUTING.md for details. -->
 # Project Information
 
 @@toc { depth=2 }

diff --git a/project/ProjectIndexGenerator.scala b/project/ProjectIndexGenerator.scala
@@ -56,7 +56,8 @@ object ProjectIndexGenerator extends AutoPlugin {
       markdownFilesBeforeLicense ++ markdownFilesAfterLicense
     }
 
-    val content = s"""# Project Information
+    val content = s"""<!-- DO NOT EDIT DIRECTLY: This file is generated by `project/ProjectIndexGenerator`. See CONTRIBUTING.md for details. -->
+                     |# Project Information
                      |
                      |@@toc { depth=2 }
                      |