-
-
Notifications
You must be signed in to change notification settings - Fork 18
docs: New documentation site! #668
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
4180670
feat: Implement Starlight documentation site
cursoragent 42a64c6
Checkpoint before follow-up message
cursoragent 173293c
Add docs preview workflow
cursoragent b575bba
fix: Use environment variable for docs preview base path
cursoragent e61baf4
fix: Add .nojekyll to prevent GitHub Pages ignoring _astro folder
cursoragent 15bf805
fix: Ensure .nojekyll exists at gh-pages root for previews
cursoragent 1909c91
refactor: Move .nojekyll to repo root
cursoragent 9efc3f0
fix: Add .nojekyll to gh-pages branch root
cursoragent 70df5d2
fix: Use relative links for internal navigation
cursoragent 8363aec
docs: Add NPM workspaces support documentation
cursoragent 0665a25
refactor: Use yarn instead of npm for docs
cursoragent bebec78
Refactor: Update craft documentation and Dockerfile
cursoragent d4da60b
Fix: Improve .nojekyll handling in docs-preview workflow
cursoragent ff8095a
Checkpoint before follow-up message
cursoragent File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| name: Docs Preview | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'docs/**' | ||
| - '.github/workflows/docs-preview.yml' | ||
|
|
||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| preview: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '22' | ||
|
|
||
| - name: Build Docs for Preview | ||
| working-directory: docs | ||
| env: | ||
| # Override base path for PR preview | ||
| DOCS_BASE_PATH: /craft/pr-preview/pr-${{ github.event.pull_request.number }} | ||
| run: | | ||
| yarn install --frozen-lockfile | ||
| yarn build | ||
|
|
||
| - name: Ensure .nojekyll at gh-pages root | ||
| run: | | ||
| git config user.name "github-actions[bot]" | ||
| git config user.email "github-actions[bot]@users.noreply.github.com" | ||
|
|
||
| # Try to fetch the gh-pages branch | ||
| if git fetch origin gh-pages:gh-pages 2>/dev/null; then | ||
| # Branch exists remotely, check if .nojekyll is present | ||
| if git show gh-pages:.nojekyll &>/dev/null; then | ||
| echo ".nojekyll already exists at gh-pages root" | ||
| else | ||
| echo "Adding .nojekyll to existing gh-pages branch" | ||
| git checkout gh-pages | ||
| touch .nojekyll | ||
| git add .nojekyll | ||
| git commit -m "Add .nojekyll to disable Jekyll processing" | ||
| git push origin gh-pages | ||
| git checkout - | ||
| fi | ||
| else | ||
| # Branch doesn't exist, create it as an orphan branch | ||
| echo "Creating gh-pages branch with .nojekyll" | ||
| git checkout --orphan gh-pages | ||
| git rm -rf . | ||
| touch .nojekyll | ||
| git add .nojekyll | ||
| git commit -m "Initialize gh-pages with .nojekyll" | ||
| git push origin gh-pages | ||
| git checkout - | ||
| fi | ||
|
|
||
| - name: Deploy Preview | ||
| uses: rossjrw/pr-preview-action@v1 | ||
| with: | ||
| source-dir: docs/dist/ | ||
| preview-branch: gh-pages | ||
| umbrella-dir: pr-preview | ||
| action: auto | ||
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
Empty file.
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
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.