From 76989926c6273594d1ab96ddede562e60fe07c6a Mon Sep 17 00:00:00 2001 From: Jo Humphrey <31373245+jamdelion@users.noreply.github.com> Date: Mon, 21 Oct 2024 16:38:14 +0100 Subject: [PATCH] docs: add link to schema viewer in readme --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d3da5fc..aa75f726 100644 --- a/README.md +++ b/README.md @@ -53,11 +53,13 @@ Run `pnpm build-json-examples` to automatically generate a corresponding JSON fi Run `pnpm test` to confirm your example payload can be successfully validated against the Digital Planning Data schema. -## Publishing +## Publishing and viewing To publish a new version, open a pull request against `main` which increments the `package.json` version. On merge, the [publish.yml](https://github.com/theopensystemslab/digital-planning-data-schemas/blob/main/.github/workflows/publish.yml) GitHub Action will update the `dist` branch, create a release, and publish the new version via GitHub pages at `http://theopensystemslab.github.io/digital-planning-data-schemas//schemas/.json` +The latest schema is also viewable at [https://theopensystemslab.github.io/digital-planning-data-schemas-docs/](https://theopensystemslab.github.io/digital-planning-data-schemas-docs/). + ## Contributing We welcome feedback, bug reports, and contributions to help improve and grow the Digital Planning Data schemas via GitHub Issues and Pull Requests.