Conversation
Adds a GitHub Pages documentation website using Astro + Starlight: - Landing page with terminal demo and feature highlights - Command reference docs (auth, org, project, issue, event, api) - Getting started and contributing guides - PR preview workflow for testing doc changes - Craft gh-pages target for deployment
Contributor
Semver Impact of This PR🟢 Patch (bug fixes) 📋 Changelog PreviewThis is how your changes will appear in the changelog. New Features ✨Issue
Other
Bug Fixes 🐛Issue
Other
Documentation 📚
Internal Changes 🔧
Other
🤖 This preview updates automatically when you update the PR. |
Contributor
Codecov Results 📊✅ Patch coverage is 100.00%. Project has 1663 uncovered lines. Files with missing lines (22)
Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 64.79% 64.79% —%
==========================================
Files 39 39 —
Lines 4723 4723 —
Branches 0 0 —
==========================================
+ Hits 3060 3060 —
- Misses 1663 1663 —
- Partials 0 0 —Generated by Codecov Action |
- Boost text contrast for better readability (body text 60% → 90%) - Force dark mode via script injection regardless of system preference - Style doc content: headings, paragraphs, lists, tables, code blocks - Fix sidebar headers (GETTING STARTED, etc.) to be white - Fix GitHub icon to be white - Fix 'On this page' header to be white - Widen search bar and reduce size - Use only github-dark theme for code blocks
- Fix code block borders and styling - Add PackageManagerCode component with integrated tabs - Update installation page to use tabs for npm/pnpm/yarn/bun - Fix various CSS specificity issues
…Seer Why, Works With Everything
…erminal padding, mobile centering
…er column classes
Shows 'You made it to the end. Might as well give it a try' message when scrolling past the bottom of the /cli landing page
Contributor
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 2 potential issues.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
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.
Summary
Adds a GitHub Pages documentation website for the CLI, modeled after how it was done for getsentry/craft.
What's included
Stack
To deploy
After merging, enable GitHub Pages in repo settings:
The first release via craft will deploy the docs.
Preview locally