Skip to content

Add documentation site with GitHub Pages deployment#3

Merged
psd-coder merged 1 commit intomainfrom
docs
Apr 6, 2026
Merged

Add documentation site with GitHub Pages deployment#3
psd-coder merged 1 commit intomainfrom
docs

Conversation

@psd-coder
Copy link
Copy Markdown
Owner

Overview

Introduces a documentation site for the project, built with Astro and deployed automatically to GitHub Pages on pushes to
main.

Problem Statement

The project lacked public-facing documentation, making it harder for users to understand the API and usage patterns.

Solution Approach

  • Added a docs/ workspace with an Astro-based site using a custom docs theme
  • Wrote initial documentation covering the library's API in a single MDX page
  • Added a CI workflow that builds and deploys the docs to GitHub Pages via OIDC trusted publishing
  • Excluded docs/ from the root workspace scripts to keep the main build unaffected

Breaking Changes

None.

@psd-coder psd-coder self-assigned this Apr 6, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 6, 2026

size-limit report 📦

Path Size
createTypedChannel 254 B (0%)
createPostMessageTransport 86 B (0%)
createEventTargetTransport 109 B (0%)

@psd-coder psd-coder force-pushed the docs branch 2 times, most recently from 7b56831 to 1525673 Compare April 6, 2026 00:53
@psd-coder psd-coder merged commit 166be39 into main Apr 6, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant