From 63151b5f1fdb6c1ad843d1421ea354b84fb51378 Mon Sep 17 00:00:00 2001
From: williamito <williamito@google.com>
Date: Mon, 6 May 2024 18:41:10 -0700
Subject: [PATCH] Docs housekeeping (#2493)

* Docs housekeeping

Change module names to pretty human readable version, add skeleton Module.md files for each module to allow for module/package level documentation in the future.

* Update datacapture/Module.md

Co-authored-by: Jing Tang <jingtang@google.com>

---------

Co-authored-by: Jing Tang <jingtang@google.com>
---
 datacapture/Module.md        |  5 +++++
 datacapture/build.gradle.kts |  4 ++--
 engine/Module.md             | 19 +++++++++++++++++++
 engine/build.gradle.kts      |  4 ++--
 knowledge/Module.md          |  4 ++++
 knowledge/build.gradle.kts   |  4 ++--
 workflow/Module.md           |  4 ++++
 workflow/build.gradle.kts    |  4 ++--
 8 files changed, 40 insertions(+), 8 deletions(-)
 create mode 100644 datacapture/Module.md
 create mode 100644 engine/Module.md
 create mode 100644 knowledge/Module.md
 create mode 100644 workflow/Module.md

diff --git a/datacapture/Module.md b/datacapture/Module.md
new file mode 100644
index 0000000000..20bb12179b
--- /dev/null
+++ b/datacapture/Module.md
@@ -0,0 +1,5 @@
+# Module Android FHIR Structured Data Capture Library
+
+The Structured Data Capture Library lets you easily build Android
+applications that capture and process healthcare data using FHIR Questionnaires.
+
diff --git a/datacapture/build.gradle.kts b/datacapture/build.gradle.kts
index 7cbebeb23c..56ec2b54f2 100644
--- a/datacapture/build.gradle.kts
+++ b/datacapture/build.gradle.kts
@@ -128,9 +128,9 @@ tasks.dokkaHtml.configure {
   suppressInheritedMembers.set(true)
   dokkaSourceSets {
     named("main") {
-      moduleName.set(Releases.DataCapture.artifactId)
+      moduleName.set(Releases.DataCapture.name)
       moduleVersion.set(Releases.DataCapture.version)
-      noAndroidSdkLink.set(false)
+      includes.from("Module.md")
       sourceLink {
         localDirectory.set(file("src/main/java"))
         remoteUrl.set(
diff --git a/engine/Module.md b/engine/Module.md
new file mode 100644
index 0000000000..e2e1bec1e0
--- /dev/null
+++ b/engine/Module.md
@@ -0,0 +1,19 @@
+# Module Android FHIR Engine Library
+
+The FHIR Engine Library stores and manages FHIR resources locally on Android and
+synchronizes with FHIR servers.
+
+# Package com.google.android.fhir
+
+Entrypoint for the Data Access API: basic access to local FHIR resources,
+namely, the CRUD operations: create, read, update, and delete. 
+
+# Package com.google.android.fhir.search
+
+Entrypoint for the Search API: a Kotlin DSL (domain-specific language) for
+searching local FHIR resources.
+
+# Package com.google.android.fhir.sync
+
+Entrypoint for the Sync API: synchronizes local FHIR resources with a remote
+FHIR server/store.
\ No newline at end of file
diff --git a/engine/build.gradle.kts b/engine/build.gradle.kts
index e80b3349ee..4dbccd672c 100644
--- a/engine/build.gradle.kts
+++ b/engine/build.gradle.kts
@@ -164,9 +164,9 @@ tasks.dokkaHtml.configure {
   suppressInheritedMembers.set(true)
   dokkaSourceSets {
     named("main") {
-      moduleName.set(Releases.Engine.artifactId)
+      moduleName.set(Releases.Engine.name)
       moduleVersion.set(Releases.Engine.version)
-      noAndroidSdkLink.set(false)
+      includes.from("Module.md")
       sourceLink {
         localDirectory.set(file("src/main/java"))
         remoteUrl.set(
diff --git a/knowledge/Module.md b/knowledge/Module.md
new file mode 100644
index 0000000000..ba0204562a
--- /dev/null
+++ b/knowledge/Module.md
@@ -0,0 +1,4 @@
+# Module Android FHIR Knowledge Manager Library
+
+The Knowledge Manager Library manages knowledge resources locally on Android and
+supports other libraries with knowledge resources.
\ No newline at end of file
diff --git a/knowledge/build.gradle.kts b/knowledge/build.gradle.kts
index 3a4cc59b40..7cd6cdc356 100644
--- a/knowledge/build.gradle.kts
+++ b/knowledge/build.gradle.kts
@@ -118,9 +118,9 @@ tasks.dokkaHtml.configure {
   suppressInheritedMembers.set(true)
   dokkaSourceSets {
     named("main") {
-      moduleName.set(Releases.Knowledge.artifactId)
+      moduleName.set(Releases.Knowledge.name)
       moduleVersion.set(Releases.Knowledge.version)
-      noAndroidSdkLink.set(false)
+      includes.from("Module.md")
       sourceLink {
         localDirectory.set(file("src/main/java"))
         remoteUrl.set(
diff --git a/workflow/Module.md b/workflow/Module.md
new file mode 100644
index 0000000000..055d4e9f2e
--- /dev/null
+++ b/workflow/Module.md
@@ -0,0 +1,4 @@
+# Module Android FHIR Workflow Library
+
+The Workflow Library provides decision support logic and analytics in clinical
+workflows.
\ No newline at end of file
diff --git a/workflow/build.gradle.kts b/workflow/build.gradle.kts
index 5c49a5df84..8342fd38e0 100644
--- a/workflow/build.gradle.kts
+++ b/workflow/build.gradle.kts
@@ -128,9 +128,9 @@ tasks.dokkaHtml.configure {
   suppressInheritedMembers.set(true)
   dokkaSourceSets {
     named("main") {
-      moduleName.set(Releases.Workflow.artifactId)
+      moduleName.set(Releases.Workflow.name)
       moduleVersion.set(Releases.Workflow.version)
-      noAndroidSdkLink.set(false)
+      includes.from("Module.md")
       sourceLink {
         localDirectory.set(file("src/main/java"))
         remoteUrl.set(