temporalio / temporalio/sdk-typescript
[Docs] Versionize documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- TypeScript
- Stars
- 917
- Forks
- 224
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 43
Description
Relevant both for docs and API reference. And latest version of API ref could be deployed from release branch instead of main so that it's not ahead of what's published on npm.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation and API-reference publishing configuration, then inspect how deployments currently use the main and release branches. Define the versioning behavior for both docs and the API reference, including alignment with the version published on npm. Confirm the publishing workflow reflects the agreed branch and version behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100