Conversation
brnrdog
force-pushed
the
claude/rescript-docs-website-tMysI
branch
from
6876031 to
8527878
Compare
Create a new documentation website using xote, basefn, and rescript-signals: - Set up ReScript v12 project with Vite for building - Configure for GitHub Pages deployment at brnrdog.github.io/rescript-signals - Add sidebar navigation with API documentation and examples - Create interactive examples (Counter, Todo List, Derived State) - Include API reference pages for Signal, Computed, and Effect primitives - Add syntax-highlighted code blocks using highlight.js
Add workflow to automatically build and deploy docs-website to GitHub Pages when changes are pushed to main branch. Uses modern GitHub Pages deployment with actions/deploy-pages. Triggers on: - Push to main branch (changes to docs-website/ or workflow file) - Manual workflow dispatch
- Hide sidebar on homepage, show only on inner pages - Add version number badge and GitHub icon to topbar - Add Release Notes page that fetches and renders CHANGELOG.md - Fix CodeBlock component to properly render syntax highlighted code - Add global styles to fix layout gaps and improve spacing - Improve overall styling consistency
Add a search component that allows users to search across all documentation pages including API references, examples, and getting started guides. The search displays results in a dropdown with category badges.
Add EditOnGitHub component that displays a link at the bottom of each documentation page, allowing users to easily contribute improvements.
Add a copy button to all code blocks that copies the code to clipboard and shows "Copied!" feedback for 2 seconds.
Sidebar navigation items now highlight based on the current URL path, making it clear which page the user is currently viewing.
Add PageNavigation component that shows links to navigate between documentation pages in sequence, making it easier to read through the docs in order.
Add Breadcrumbs component that shows the navigation hierarchy at the top of each documentation page, helping users understand their location within the docs structure.
Add ScrollToTop component that appears when the user scrolls down the page, allowing quick navigation back to the top of the document.
brnrdog
force-pushed
the
claude/rescript-docs-website-tMysI
branch
from
8527878 to
0511ca7
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.