feat: move docs to repo root for GitHub navigation#2770
Draft
zastrowm wants to merge 3 commits into
Draft
Conversation
GitHub renders symlink-to-directory as a file entry rather than a folder. Use a real docs/ directory containing symlinks to each subdirectory so it appears as a folder in the GitHub tree view.
Move site/src/content/docs/ to the top-level docs/ directory so it appears as a navigable folder on GitHub. A symlink at the original location points back so Astro/Starlight continues to find the content. Added preserveSymlinks to the Vite config so module resolution uses the symlink path (inside site/) rather than the real path (repo root).
zastrowm
requested a deployment
to
manual-approval
GitHub Actions
Waiting
github-actions
Bot
added
chore
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.
Description
Move
site/src/content/docs/to the top-leveldocs/directory so it appears as a navigable folder on GitHub. A reverse symlink at the original location (site/src/content/docs -> ../../../docs) ensures Astro/Starlight continues to find the content without changes to the build pipeline.Added
preserveSymlinks: trueto the Vite config so module resolution uses the symlink path (insidesite/) rather than the resolved real path, which fixes@astrojs/starlight/componentsimport resolution.Related Issues
N/A
Documentation PR
N/A — this restructures where docs live, no content changes.
Type of Change
Other (please describe): Developer experience — docs are now browsable directly from the GitHub repo root.
Testing
Verified
npx astro buildcompletes without module resolution errorsVerified
npx astro devstarts cleanlyBroken link checker failures are pre-existing (missing generated API docs)
I ran
hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.