New documentation site setup #668
Draft
Conversation
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 commit introduces the Starlight documentation site, replacing the old static HTML. It includes configuration, package updates, and necessary file additions/removals for the new documentation build process. Co-authored-by: burak.kaya <burak.kaya@sentry.io>
Contributor
|
Cursor Agent can help with this pull request. Just |
Co-authored-by: burak.kaya <burak.kaya@sentry.io>
Co-authored-by: burak.kaya <burak.kaya@sentry.io>
Contributor
|
The --base CLI flag wasn't working correctly with Starlight. Using an environment variable (DOCS_BASE_PATH) in astro.config.mjs ensures CSS and other assets load correctly in PR previews.
GitHub Pages uses Jekyll by default, which ignores files/folders starting with underscore. The .nojekyll file disables Jekyll processing so the _astro folder is served correctly.
The .nojekyll file needs to be at the root of the gh-pages branch, not just in the preview subdirectory, to disable Jekyll processing for the entire site including PR previews.
Simpler approach - place .nojekyll at repo root and copy it to docs/dist/ during build. Both the main build workflow and the PR preview workflow now copy this file to the output.
The .nojekyll file must be at the root of the gh-pages branch for GitHub Pages to disable Jekyll processing. This step checks if it exists and adds it if missing before deploying the preview.
Changed hardcoded /craft/ paths to relative paths so links work correctly with both production and PR preview base paths.
Document the workspace discovery feature including: - workspaces, includeWorkspaces, excludeWorkspaces options - artifactTemplate for custom artifact naming - Dependency ordering, private package filtering, validation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Implement an Astro + Starlight documentation site to replace the old placeholder and improve the documentation experience.
This PR introduces a new Astro + Starlight documentation site, migrating content from
README.mdandCONTRIBUTING.mdinto a structured, searchable, and responsive format. It cleans up legacy documentation artifacts, updates the CI build workflow to generate the new site, and adds convenient development scripts. The existinggh-pagesCraft target is retained for deployment simplicity.