docs: improvements for developer portal (#1362)

* docs: fix links * docs: fix links * docs: fix more links * docs: fix link to playground * docs: change docs build * docs: changed formatting for warning * docs: properly change notices for docusaurus * docs: fix linting
dhis2 · Nov 29, 2023 · 3253800 · 3253800
1 parent f32d52b
commit 3253800
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/docs/advanced/offline/README.md b/docs/advanced/offline/README.md
@@ -1,6 +1,8 @@
 # Offline tools
 
-!> **WARNING** These features are considered **experimental** and are **subject to breaking changes outside of the normal release cycle.**
+:::warning Experimental
+These features are considered **experimental** and are **subject to breaking changes outside of the normal release cycle.**
+:::
 
 The app platform provides some support for PWA features, including a `manifest.json` file for installability and service worker which can provide offline caching. In addition to those features, the app runtime provides support for ["cacheable sections"](./CacheableSections.md), which are sections of an app that can be individually cached on-demand. The [`useCacheableSection` hook](./CacheableSections.md#usecacheablesection-api) and the [`CacheableSection` component](./CacheableSections.md#cacheablesection-api) provide the controls for the section and the wrapper for the section, respectively. The [`useCachedSections` hook](./CacheableSections.md#usecachedsections-api) returns a list of sections that are stored in the cache and a function that can delete them.
 

diff --git a/docs/advanced/offline/useOnlineStatus.md b/docs/advanced/offline/useOnlineStatus.md
@@ -1,6 +1,8 @@
 # useOnlineStatus
 
-!> This hook only detects whether or not you're connected to the internet, which could be problematic for DHIS2 instances that are hosted locally or offline, where what really matters is whether or not you can communicate with the DHIS2 server. The [`useDhis2ConnectionStatus` hook](./useDhis2ConnectionStatus.md) is usually better for that reason, and is therefore recommended.
+:::info Internet Only
+This hook only detects whether or not you're connected to the internet, which could be problematic for DHIS2 instances that are hosted locally or offline, where what really matters is whether or not you can communicate with the DHIS2 server. The [`useDhis2ConnectionStatus` hook](./useDhis2ConnectionStatus.md) is usually better for that reason, and is therefore recommended.
+:::
 
 The `useOnlineStatus` returns whether the client is online or offline. It debounces the returned values by default to prevent rapid changes of any UI elements that depend on the online status.
 

diff --git a/docs/advanced/services.md b/docs/advanced/services.md
@@ -1,6 +1,8 @@
 # Services
 
-!> **NOTE**<br/>Services are purely a concept **internal** to `@dhis2/app-runtime` - you don't need to care about them to use it.
+:::caution Note
+Services are purely a concept **internal** to `@dhis2/app-runtime` - you don't need to care about them to use it.
+:::
 
 Internally, `@dhis2/app-runtime` is composed of several functionally-isolated **services**. Each of these services is a private (unpublished) npm package which is bundled into the final `@dhis2/app-runtime` library at build-time. Each services exposes a relevant Context provider as well as various Hook and Component interfaces which are re-exported by the `@dhis2/app-runtime` public package. There are currently only 2 services, but more will be added soon.