Home

Welcome to the documentation wiki for @deessejs/fp, a tiny, dependency-free TypeScript library that provides Result, Maybe, and Unit for type-safe error handling and optional-value modeling.

TL;DR

This wiki is the public-facing documentation for the project. The four pages cover (a) how to operate the wiki itself, (b) how a release happens, (c) how an urgent fix ships through the hotfix path, and (d) how to write the Changeset file that every pull request must include.

Outline

• Getting started
• Contributing

Getting started

• Wiki Operations with gh CLI: how to read, edit, and automate this wiki from the command line using gh.
• Repository: source code, issues, and releases.
• npm package: installation instructions and changelog.

Release process

• Branch Strategy: the conceptual model behind main, staging, and short-lived feature/hotfix branches.
• Authoring Changesets: how to write the Changeset file that every pull request on this project must include.
• Release Process: how a new version of @deessejs/fp is built, tested, and published to npm.
• Trusted Publishing: the one-time setup of npm OIDC for secure publish without long-lived secrets.
• Hotfix Flow: the urgent-fix path: ship to production without dragging unfinished work from staging, and how to back-merge and document the fix afterwards.
• Release Incidents: runbook for handling a broken or insecure release (deprecate, revert, hotfix).

Future channels

• Canary Snapshots: pre-release per-PR snapshots (future feature, not yet implemented).
• Pre-release Cycles: beta and rc phases (future feature, not yet implemented).

Contributing

To add or update a page, see the Wiki Operations with gh CLI guide. Pages are plain Markdown files; each save in the web UI is a Git commit, and the wiki is stored in the deessejs/fp.wiki repository.