Skip to content

Commit

Permalink
refactored the 'improve docs' section out into an Include. Misc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
pacharanero committed Dec 16, 2023
1 parent 6257a13 commit f2966f0
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 15 deletions.
1 change: 0 additions & 1 deletion docs/_assets/_snippets/docs-contributions.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/integrator/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ We require an API key to authenticate calls made and ensure they are valid. The

![getting-api-keys](../_assets/_images/getting-api-keys.png)

-----

## Next: [Making an API call](../integrator/making-api-calls.md)

-----
7 changes: 1 addition & 6 deletions docs/integrator/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,6 @@ These API keys allow us to manage usage of the API and prevent abuse. For explor

![create-an-app](../_assets/_images/create-an-app.png)

!!! tip "Improving these docs"
We're always looking for feedback on our documentation, so that we maintain clear, unambiguous guides for all parts of the platform. If something isn't clear please let us know, by [talking about it on our forums](https://openhealthhub.org/c/rcpch-digital-growth-charts), or creating an [issue on GitHub](https://github.com/rcpch/digital-growth-charts-documentation/issues). Please include enough description of the problem so we can fix it. Screenshots and links are super helpful for this.

You can also directly edit the docs and submit changes back to us for inclusion: click on the :material-pencil: button in the top left of any main text pane, which will take you to the source on GitHub. You will need to make your own GitHub fork of the documentation. Make your changes there and submit a pull request back to us. See [Contributing](../developer/contributing.md) for more info.
## Next: [Getting API keys](../integrator/api-keys.md)

-----

## Next: [Getting API keys](../integrator/api-keys.md)
2 changes: 0 additions & 2 deletions docs/integrator/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ reviewers: Dr Marcus Baw, Dr Anchit Chandran
audience: integrators, implementers, technical-architects
---

# Support

## Commercial Support

!!! tip "Commercial support"
Expand Down
3 changes: 0 additions & 3 deletions docs/products/react-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,3 @@ It was felt that representing boys' charts with blue lines and girls' charts wit
- [Developer documentation](../developer/react-client.md)
- [Contributor documentation](../developer/start-here.md)

--8<--
docs/_assets/_snippets/docs-contributions.md
--8<--
5 changes: 5 additions & 0 deletions includes/_docs-contributions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
!!! tip "Help us improve our documentation"

We're always looking for feedback on our documentation, so that we maintain clear, unambiguous guides for all parts of the platform. If something isn't clear please let us know, by [talking about it on our forums](https://openhealthhub.org/c/rcpch-digital-growth-charts), or creating an [issue on GitHub](https://github.com/rcpch/digital-growth-charts-documentation/issues). Please include enough description of the problem so we can fix it. Screenshots and links are super helpful for this.

You can also directly edit the docs and submit changes back to us for inclusion: click on the :material-pencil: button in the top left of any main text pane, which will take you to the source on GitHub. You will need to make your own GitHub fork of the documentation. Make your changes there and submit a pull request back to us. See [Contributing](../developer/contributing.md) for more info. We will [acknowledge](../about/acknowledgements.md) all contributors.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@ nav:
# `not_in_nav` will prevent 'The following pages exist in the docs directory, but are not included in the "nav" configuration:' warnings
not_in_nav: |
_assets/_snippets/dgc-platform-comprises.md
_assets/_snippets/docs-contributions.md
_assets/_snippets/htn-award.md
_assets/_snippets/self-host-warning.md
_utilities/page-template.md
Expand Down Expand Up @@ -175,6 +174,7 @@ markdown_extensions:
check_paths: true
auto_append:
- includes/_abbreviations.md # adds abbreviations snippets to ALL pages
- includes/_docs-contributions.md # adds docs-contributions snippets to ALL pages
- pymdownx.superfences
- toc:
permalink: false
Expand Down

0 comments on commit f2966f0

Please sign in to comment.