From ce9118fe85b0d51108bd680c2d12fd6172820950 Mon Sep 17 00:00:00 2001 From: JingZhang Chen Date: Thu, 12 Oct 2023 18:58:34 +0800 Subject: [PATCH] additional documentation clarify --- CONTRIBUTING.md | 5 +++++ docs/src/main/paradox/project/project-index.md | 1 + project/ProjectIndexGenerator.scala | 3 ++- 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0c44bbc548b..51484cba124 100644 --- 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 index 58574cde845..ac955843ab5 100644 --- a/docs/src/main/paradox/project/project-index.md +++ b/docs/src/main/paradox/project/project-index.md @@ -1,3 +1,4 @@ + # Project Information @@toc { depth=2 } diff --git a/project/ProjectIndexGenerator.scala b/project/ProjectIndexGenerator.scala index 422b0e02660..1bcdd3d24da 100644 --- 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""" + |# Project Information | |@@toc { depth=2 } |