Move README.md content to the doc site (#2610)

* Move README.md to the doc site * correct doc site link * add mailto link * line breaks
google · Jul 10, 2024 · 1d2da89 · 1d2da89
1 parent 7a26aba
commit 1d2da89
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -7,44 +7,7 @@ healthcare applications using the [HL7® FHIR® standard](https://www.hl7.org/fh
 aims to accelerate the adoption of FHIR by making it easy to incorporate FHIR into new and existing
 mobile applications.
 
-## Libraries
-
-The SDK contains the following libraries:
-
-| Library              | Latest release                                                                                                                                                                                                                    | Code                                                                  | Docs                                                                                | Min SDK                    | Summary                                                                                                                                                    |
-| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Data Capture Library | [![Google Maven](https://badgen.net/maven/v/metadata-url/dl.google.com/dl/android/maven2/com/google/android/fhir/data-capture/maven-metadata.xml)](https://maven.google.com/web/index.html?#com.google.android.fhir:data-capture) | [code](https://github.com/google/android-fhir/tree/master/datacapture)| [docs](https://google.github.io/android-fhir/use/SDCL/) | Android 7.0 (API level 24) | Collect, validate, and process healthcare data on Android                                                                                                  |
-| FHIR Engine Library  | [![Google Maven](https://badgen.net/maven/v/metadata-url/dl.google.com/dl/android/maven2/com/google/android/fhir/engine/maven-metadata.xml)](https://maven.google.com/web/index.html?#com.google.android.fhir:engine)             | [code](https://github.com/google/android-fhir/tree/master/engine)     | [docs](https://google.github.io/android-fhir/use/FEL/)             | Android 7.0 (API level 24) | Store and manage FHIR resources locally on Android and synchronize with FHIR server                                                                        |
-| Workflow Library     | [![Google Maven](https://badgen.net/maven/v/metadata-url/dl.google.com/dl/android/maven2/com/google/android/fhir/workflow/maven-metadata.xml)](https://maven.google.com/web/index.html?#com.google.android.fhir:workflow)         | [code](https://github.com/google/android-fhir/tree/master/workflow)   | [docs](https://google.github.io/android-fhir/use/WFL/)                | Android 7.0 (API level 24) | Provide decision support and analytics in clinical workflow on Android including implementation of specific FHIR operations ($measure_evaluate and $apply) |
-
-## Demo apps
-
-This repository also contains the following demo apps:
-
-| Demo app                            | Code                                                               | Docs                                                              |
-| ----------------------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------- |
-| FHIR Engine Demo App                | [code](https://github.com/google/android-fhir/tree/master/demo)    | [docs](https://google.github.io/android-fhir/use/FEL/Demo-app/)   |
-| Structured Data Capture Catalog App | [code](https://github.com/google/android-fhir/tree/master/catalog) | [docs](https://google.github.io/android-fhir/use/SDCL/Demo-app/)  |
-
-**These applications are provided for demo purposes only. Do NOT use in production.**
-
-## Contributing
-
-The development of the SDK began as a collaborative effort between Google, [The World Health Organization](https://www.who.int/), and [Ona](https://ona.io/). Since then, a consortium of application developers have been contributing to the project.
-
-To contribute to the project, please see [Contributing](https://google.github.io/android-fhir/contrib/) to get started.
-
-## Feedback and getting help
-
-You can create a [GitHub issue](https://github.com/google/android-fhir/issues) for bugs and feature requests.
-
-In case you find any security bug, please do NOT create a GitHub issue. Instead, email us at <[email protected]>.
-
-If you want to provide any feedback or discuss use cases you can:
-
-* email us at <[email protected]>
-* start a [GitHub discussion](https://github.com/google/android-fhir/discussions)
-* start a new topic in [android](https://chat.fhir.org/#narrow/stream/276344-android), [questionnaire](https://chat.fhir.org/#narrow/stream/179255-questionnaire), [implementers](https://chat.fhir.org/#narrow/stream/179166-implementers), or [WHO SMART guidelines](https://chat.fhir.org/#narrow/stream/310477-who-smart-guidelines) stream in the [FHIR Zulip chat](https://chat.fhir.org/)
+See [documentation](https://google.github.io/android-fhir/).
 
 ## Disclaimer
 

diff --git a/docs/community.md b/docs/community.md
@@ -0,0 +1,44 @@
+# Developer Community
+
+The development of the Android FHIR SDK began as a collaborative effort between
+Google, [The World Health Organization](https://www.who.int/), and [Ona](https://ona.io/). Since
+then, a consortium of app developers have been contributing to the project.
+
+## Developers Call
+
+We host a fortnightly Android FHIR SDK Developers Call every other Thursday.
+
+> OHS Developers Call: Android FHIR SDK  
+> Every other Thursday · 10:00 – 11:00  
+> Time zone: Europe/London  
+> Google Meet joining info  
+> Video call link: https://meet.google.com/woo-hecp-ufr  
+> Or dial: (GB) +44 20 3956 2102 PIN: 937 593 189#  
+> More phone numbers: https://tel.meet/woo-hecp-ufr?pin=8022014824840
+
+Subscribe to
+the [OHS Developer Community Calendar](https://calendar.google.com/calendar/u/0?cid=Y19lMjAzMzkyMjY5MDFjYzM1MGE1YTVkNmEyODhkOTgxNDc0MTZlYzk0MzViNGU2OTAyMTgwNTMwM2QxNDgzNmEzQGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20)
+to see event details and other OHS events.
+
+Ask to join the [OHS Developers Google Group](mailto:[email protected]) to receive
+the Google Calendar invitation and the latest updates.
+
+## Raise an issue
+
+Create a [GitHub issue](https://github.com/google/android-fhir/issues) for bugs and feature
+requests.
+
+In case you find any security bug, do NOT create a GitHub issue. Instead, email us
+at <[email protected]>.
+
+## Start a discussion
+
+Start a [GitHub discussion](https://github.com/google/android-fhir/discussions) for discussions
+directly related to the Android FHIR SDK.
+Use [android](https://chat.fhir.org/#narrow/stream/276344-android), [questionnaire](https://chat.fhir.org/#narrow/stream/179255-questionnaire), [implementers](https://chat.fhir.org/#narrow/stream/179166-implementers),
+or [WHO SMART guidelines](https://chat.fhir.org/#narrow/stream/310477-who-smart-guidelines) stream
+in the [FHIR Zulip chat](https://chat.fhir.org/) for more general FHIR-related discussions.
+
+## Contact Us
+
+Email <[email protected]> to contact the team directly.
diff --git a/docs/index.md b/docs/index.md
@@ -14,27 +14,26 @@ Use the following table for documentation and resources to get started with each
 | Workflow Library             | [![Google Maven](https://badgen.net/maven/v/metadata-url/dl.google.com/dl/android/maven2/com/google/android/fhir/workflow/maven-metadata.xml)](https://maven.google.com/web/index.html?#com.google.android.fhir:workflow)     | [code](https://github.com/google/android-fhir/tree/master/workflow)   | [docs](use/WFL/index.md)                | |  Provides decision support and analytics in clinical workflow on Android including implementation of specific FHIR operations ($measure_evaluate and $apply) |
 | Knowledge Manager Library    | [![Google Maven](https://badgen.net/maven/v/metadata-url/dl.google.com/dl/android/maven2/com/google/android/fhir/knowledge/maven-metadata.xml)](https://maven.google.com/web/index.html?#com.google.android.fhir:knowledge)    | [code](https://github.com/google/android-fhir/tree/master/knowledge)  |        | | Manages knowledge resources locally on Android and supports other libraries with knowledge resources                                               |
 
-## Project information
+This repository also contains the following demo apps:
 
-* [Project roadmap](contrib/roadmap.md)
-* [FAQs](faq.md)
+| Demo app                            | Code                                                               | Docs                                                              |
+| ----------------------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------- |
+| FHIR Engine Demo App                | [code](https://github.com/google/android-fhir/tree/master/demo)    | [docs](https://google.github.io/android-fhir/use/FEL/Demo-app/)   |
+| Structured Data Capture Catalog App | [code](https://github.com/google/android-fhir/tree/master/catalog) | [docs](https://google.github.io/android-fhir/use/SDCL/Demo-app/)  |
+
+**These applications are for demo purposes only. Do NOT use in production.**
+
+Use the sidebar to navigate to other sections of the site.
 
 ## Resources
 
-### FHIR and implementation guides
+FHIR and implementation guides:
 
 * [HL7 FHIR](https://www.hl7.org/fhir/)
 * [Structured Data Capture](http://hl7.org/fhir/us/sdc/)
 * [Clinical Quality Lanugage (CQL)](https://cql.hl7.org/)
 
-### More on mobile health landscape
+More on mobile health landscape:
 
 * [Digital Health Atlas](https://digitalhealthatlas.org/)
 * [Global Goods Guidebook](https://digitalsquare.org/global-goods-guidebook)
-
-### Community
-
-* [Zulip FHIR chat](https://chat.fhir.org/) has the following streams that are relevant to this codebase:
-  * [#android](https://chat.fhir.org/#narrow/stream/276344-android)
-  * [#implementers](https://chat.fhir.org/#narrow/stream/179166-implementers)
-  * [#questionnaire](https://chat.fhir.org/#narrow/stream/179255-questionnaire) for the SDC library and gallery
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -6,7 +6,6 @@ copyright: Copyright 2024 The Android FHIR SDK Authors
 
 nav:
   - Home: index.md
-  - faq.md
   - Users:
       - FHIR Engine Library:
           - Introduction: use/FEL/index.md
@@ -48,7 +47,9 @@ nav:
       - Codespaces: contrib/codespaces.md
       - Documentation: contrib/docs.md
       - contrib/dependencies.md
-      - Roadmap: contrib/roadmap.md
+  - Roadmap: contrib/roadmap.md
+  - Community: community.md
+  - faq.md
 
 # The following settings were originally partially inspired by
 # https://github.com/enola-dev/enola/blob/main/mkdocs.yaml