Skip to content

Commit

Permalink
docs: add link to schema viewer in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jamdelion committed Oct 21, 2024
1 parent 5f099c9 commit 7698992
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<VERSION>/schemas/<SCHEMA>.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.

Expand Down

0 comments on commit 7698992

Please sign in to comment.