Skip to content

Docs

Developer Documentation for both users of and contributors to this project is maintained alongside its code in the docs/ folder its git repo.

The https://google.github.io/android-fhir/ website is automatically generated from this with Continous Integration.

This website is built using Material for MkDocs.

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.

To generate the website, for simplicity we recommend using GitHub Codespaces; in a Terminal of such a Codespace:

  1. pipenv shell: This enters a Python "virtual environment" (venv), using pipenv

  2. mkdocs serve

  3. Confirm Codespace's "Port Forward" prompt to open https://...app.github.dev, et voilà!