-
Notifications
You must be signed in to change notification settings - Fork 250
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
661 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
{ | ||
"recommendations": ["davidanson.vscode-markdownlint"] | ||
"recommendations": [ | ||
"davidanson.vscode-markdownlint", | ||
"streetsidesoftware.code-spell-checker", | ||
"redhat.vscode-yaml" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
// https://squidfunk.github.io/mkdocs-material/creating-your-site/ | ||
"yaml.schemas": { | ||
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" | ||
}, | ||
"yaml.customTags": [ | ||
"!ENV scalar", | ||
"!ENV sequence", | ||
"!relative scalar", | ||
"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg", | ||
"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji", | ||
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
[[source]] | ||
url = "https://pypi.org/simple" | ||
verify_ssl = true | ||
name = "pypi" | ||
|
||
[packages] | ||
mkdocs-material = "*" | ||
|
||
[dev-packages] | ||
|
||
[requires] | ||
python_version = "3.11" |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Docs | ||
|
||
Developer Documentation for both users of and contributors to this project is maintained | ||
alongside its code in [the `docs/` folder its git repo](https://github.com/google/android-fhir/tree/master/docs). | ||
|
||
The <https://google.github.io/android-fhir/> website is automatically generated from this with Continous Integration. | ||
|
||
This website is built using [Material](https://squidfunk.github.io/mkdocs-material/) for [MkDocs](https://www.mkdocs.org/). | ||
|
||
## Contribute | ||
|
||
Contributions to the documentation are very welcome, and should typically be made together with code contributions. | ||
|
||
You can edit the `docs/**.md` files with any editor you like and include such changes with your regular Pull Requests. | ||
|
||
New MD files needs to be added to `nav:` in [`mkdocs.yaml`](https://github.com/google/android-fhir/blob/master/mkdocs.yaml). | ||
|
||
To generate the website, for simplicity we recommend using [GitHub Codespaces](codespaces.md); in a Terminal of such a Codespace: | ||
|
||
1. `pipenv shell`: This enters a [Python "virtual environment" (`venv`)](https://docs.python.org/3/library/venv.html), using [`pipenv`](https://pipenv.pypa.io/) | ||
|
||
1. `mkdocs serve` | ||
|
||
1. Confirm Codespace's _"Port Forward"_ prompt to open `https://...app.github.dev`, et voilà! | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Welcome to Android FHIR SDK Technical Documentation | ||
|
||
The Android FHIR SDK is a set of Kotlin libraries for building offline-capable, mobile-first | ||
healthcare applications using the [HL7® FHIR® standard](https://www.hl7.org/fhir/) on Android. It | ||
aims to accelerate the adoption of FHIR by making it easy to incorporate FHIR into new and existing | ||
mobile applications. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# API | ||
|
||
* [Engine](/api/engine/1.0.0/) | ||
* [Data Capture](/data-capture/1.1.0/) | ||
* [Workflow](/api/workflow/0.1.0-alpha04/) | ||
* [Knowledge](/api/knowledge/0.1.0-alpha03/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
site_name: Android FHIR SDK | ||
site_url: https://google.github.io/android-fhir/ | ||
repo_url: https://github.com/google/android-fhir/ | ||
edit_uri: blob/master/docs/ | ||
copyright: Copyright 2024 The Android FHIR SDK Authors | ||
|
||
nav: | ||
- Users: | ||
- API: use/api.md | ||
- Contributors: | ||
- Codespaces: contrib/codespaces.md | ||
- Documentation: contrib/docs.md | ||
|
||
theme: | ||
name: material | ||
features: | ||
- content.action.edit | ||
- content.code.copy | ||
- navigation.expand | ||
- navigation.footer | ||
- navigation.instant | ||
- navigation.tracking | ||
- navigation.expand | ||
- navigation.path | ||
- navigation.top | ||
- navigation.sections | ||
- navigation.tabs | ||
- search.suggest | ||
- search.share |