1266/1234: Publish package to npm, deploy docs and update documentation #12

9inpachi · 2024-05-28T10:36:30Z

This is the final set of changes for the release. Once this is merged, we can release the v1.0.0 of the SDK.

It includes.

Publishing the package to npm instead of GitHub.
- This has been tested through the pipeline but the package is deleted from npm since it was a test release.
Deploy docusaurus documentation to GitHub pages.
Update READMEs and other documentation to reflect the latest changes.
Add badges to README (they will only work once the repo is public).
Update theme of the docs to reflect Puffer logo colors.

…ease

9inpachi added 11 commits May 28, 2024 12:26

Update publish action to use npm registry

c5e4409

Remove dist directory and don't include it in release

e5b3806

Make package access public

2bd2488

Update README to include updated information

69e93d1

Update typedoc config to consider broader files and build docs on rel…

ecd9838

…ease

Configure deployment of docs on publish

0220c96

Add docs build to git before release

58f33ac

Deploy docs for testing

8645377

Fix docusaurus config and use github actions for pages deployment

2ee5d7f

Update custom CSS and README

d1bacb7

Rename actions and fix docusaurus search config

49e4e0f

9inpachi requested review from guestn, rish-puffer, JasonVranek and SebForz May 28, 2024 11:04

guestn approved these changes May 28, 2024

View reviewed changes

9inpachi merged commit 9036410 into main May 28, 2024
1 check passed

9inpachi deleted the 1266/npm-publish branch May 30, 2024 12:42

Provide feedback