Skip to content

Commit

Permalink
docs: add warning about doc freshness
Browse files Browse the repository at this point in the history
Since the dapi-client pages are coming from the platform repo, this adds a note and link to source in case devs missed an update or something.
  • Loading branch information
thephez committed Aug 28, 2024
1 parent 0b44f77 commit 7cf2279
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/dapi-client-js/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
.. _dapi-client-js-index:
```

:::{attention}
This documentation is based on the [docs directory in the repository](https://github.com/dashpay/platform/tree/master/packages/js-dapi-client/docs) and may not always reflect recent code changes. For the most up-to-date information, please refer to the latest version of the code.
:::

# Overview

## DAPI-Client
Expand Down
4 changes: 4 additions & 0 deletions docs/dapi-client-js/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
:::{attention}
This documentation is based on the [docs directory in the repository](https://github.com/dashpay/platform/tree/master/packages/js-dapi-client/docs) and may not always reflect recent code changes. For the most up-to-date information, please refer to the latest version of the code.
:::

# Quick start

## ES5/ES6 via NPM
Expand Down
4 changes: 4 additions & 0 deletions docs/dapi-client-js/usage/core/core.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Core

:::{attention}
This documentation is based on the [docs directory in the repository](https://github.com/dashpay/platform/tree/master/packages/js-dapi-client/docs) and may not always reflect recent code changes. For the most up-to-date information, please refer to the latest version of the code.
:::

```{toctree}
:maxdepth: 2
:titlesonly:
Expand Down
4 changes: 4 additions & 0 deletions docs/dapi-client-js/usage/platform/platform.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Platform

:::{attention}
This documentation is based on the [docs directory in the repository](https://github.com/dashpay/platform/tree/master/packages/js-dapi-client/docs) and may not always reflect recent code changes. For the most up-to-date information, please refer to the latest version of the code.
:::

```{toctree}
:maxdepth: 2
:titlesonly:
Expand Down
4 changes: 4 additions & 0 deletions docs/dapi-client-js/usage/usage.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Usage

:::{attention}
This documentation is based on the [docs directory in the repository](https://github.com/dashpay/platform/tree/master/packages/js-dapi-client/docs) and may not always reflect recent code changes. For the most up-to-date information, please refer to the latest version of the code.
:::

```{toctree}
:maxdepth: 2
:titlesonly:
Expand Down

0 comments on commit 7cf2279

Please sign in to comment.