Skip to content

Commit

Permalink
Add operations doc sidebar
Browse files Browse the repository at this point in the history
  • Loading branch information
fongsean committed Jul 8, 2024
1 parent 8d0cd2b commit 0acbc01
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/docs/api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ sidebar_label: Introduction

This section is automatically generated from the source code using [TypeDoc and its plugin for Docusaurus](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/main/packages/docusaurus-plugin-typedoc#readme).

It provides a full coverage of the exposed API of [@aehrc/smart-forms-renderer](https://www.npmjs.com/package/@aehrc/smart-forms-renderer) and [@aehrc/sdc-populate](https://www.npmjs.com/package/@aehrc/sdc-populate).
It provides a full coverage of the exposed API of [@aehrc/smart-forms-renderer](https://www.npmjs.com/package/@aehrc/smart-forms-renderer), [@aehrc/sdc-populate](https://www.npmjs.com/package/@aehrc/sdc-populate) and [@aehrc/sdc-assemble](https://www.npmjs.com/package/@aehrc/sdc-assemble).
25 changes: 25 additions & 0 deletions documentation/docs/operations/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 1
sidebar_label: Introduction
---

# FHIR Operations

Smart Forms provides reference implementations for `$populate` and `$assemble` operations as [ExpressJS](https://expressjs.com/) services to complement the FHIR Questionnaire renderer.
These operations are available as Docker images and can be deployed as microservices.

[//]: # '1. **`$populate`**'
[//]: # ' Operation definition: [SDCPopulateQuestionnaire](http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populate)'
[//]: # ' Github repository:'
[//]: #
[//]: # ' A React-based library that contains the rendering engine. It acts as a reference implementation for the [SDC Form Filler](https://hl7.org/fhir/uv/sdc/CapabilityStatement-sdc-form-filler.html).'
[//]: #
[//]: # '2. **`$assemble`** ([@aehrc/sdc-populate](https://www.npmjs.com/package/@aehrc/sdc-populate))'
[//]: #
[//]: # ' A reference implementation of the [SDC Populate Questionnaire](https://hl7.org/fhir/uv/sdc/OperationDefinition-Questionnaire-populate.html) operation, also known as $populate.'
[//]: # ' Currently, there are no written documentation available for this library. Please refer to the [API](/docs/api/sdc-populate) for more information.'
[//]: #
[//]: # '3. **SDC Assemble** ([@aehrc/sdc-assemble](https://www.npmjs.com/package/@aehrc/sdc-assemble))'
[//]: #
[//]: # ' A reference implementation of the [SDC Assemble Questionnaire](https://hl7.org/fhir/uv/sdc/OperationDefinition-Questionnaire-assemble.html) operation, also known as $assemble.'
[//]: # ' Currently, there are no written documentation available for this library. Please refer to the [API](/docs/api/sdc-assemble) for more information.'
6 changes: 6 additions & 0 deletions documentation/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,12 @@ const config: Config = {
position: 'left',
label: 'Developer Usage'
},
{
type: 'docSidebar',
sidebarId: 'operationsSidebar',
position: 'left',
label: 'FHIR Operations'
},
{
type: 'docSidebar',
sidebarId: 'apiSidebar',
Expand Down
1 change: 1 addition & 0 deletions documentation/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const sidebars: SidebarsConfig = {
{ type: 'autogenerated', dirName: 'dev' },
{ type: 'link', label: 'Playground', href: 'https://smartforms.csiro.au/playground' }
],
operationsSidebar: [{ type: 'autogenerated', dirName: 'operations' }],
apiSidebar: [{ type: 'autogenerated', dirName: 'api' }]
};

Expand Down

0 comments on commit 0acbc01

Please sign in to comment.