Versioned Docs

[martin0995]

This pull request updates the documentation workflow and associated files to streamline the process of generating and managing versioned documentation for the Wormhole SDK. The changes simplify the GitHub Actions workflow, add new documentation, and introduce version tracking for the documentation.

Documentation Enhancements

• docs/README.md): Added a new README file explaining the folder structure, update process, and best practices for maintaining the documentation.

Versioned Documentation Script

• docs/scripts/versioned-docs.ts: The script reads the current SDK version from package.json, and if it detects a new major version, it copies docs/latest/ to docs/vX/, regenerates docs/latest/ using TypeDoc, and updates .version to track the latest documented version.

Version Tracking

• docs/.version: Introduced a new .version file to track the latest built documentation version, starting with version 2.2.0.

Workflow Improvements

• .github/workflows/update-docs.yml: Simplified the workflow by replacing the NPM version retrieval with extracting the version from the release tag, consolidating dependency installation steps, and improving the Git commit process to include both package.json and documentation updates.

⚠️ GitHub Pages Configuration Required

For users to access the versioned docs live, we need to update GitHub Pages to serve from the /docs folder in the main branch.

The docs should be accessible at:

• https://wormhole-foundation.github.io/wormhole-sdk-ts/latest/
• https://wormhole-foundation.github.io/wormhole-sdk-ts/v1/

[kev1n-peters]

I don't think we should run this action if the tag was a beta tag (e.g. 2.3.0-beta.0) since we probably wouldn't merge the package.json file with the beta version set.

[martin0995]

I just added this line at the beginning to skip the workflow for beta versions:
if: ${{ !contains(github.ref, '-') }}

[martin0995]

@kev1n-peters GitHub Action is failing to create the pull request because it doesn't have permission to do so. Someone with admin access needs to update the repository settings to allow it.