Merged
Conversation
- Changed sidebar links from directory URLs to explicit README paths
- Fixes 404 errors on /api/generated/{resource,errors,transport}/
- Generated docs now properly accessible via /api/generated/*/README
VitePress generates README.html instead of index.html for TypeDoc
markdown files, so directory URLs don't work on GitHub Pages.
Closes #14
Contributor
There was a problem hiding this comment.
Pull Request Overview
Fixes 404 errors on generated API documentation by updating VitePress sidebar configuration to use explicit README file paths instead of directory paths. This resolves GitHub Pages routing issues where directory URLs don't automatically resolve to README.md files.
- Updated three API documentation links to point explicitly to README files
- Ensures compatibility between VitePress preview server and GitHub Pages deployment
pipewrk
added a commit
that referenced
this pull request
Nov 8, 2025
C4: Fix Generated API Docs 404 Errors
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
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.
Fixes 404 errors on generated API documentation by updating VitePress sidebar links.
Problem: Generated API docs returned 404 on GitHub Pages for directory URLs like
/api/generated/resource/Root Cause: TypeDoc generates README.md files which VitePress converts to README.html (not index.html), so directory URLs do not resolve on GitHub Pages.
Solution: Updated sidebar links to point explicitly to README paths instead of directory paths.
Testing: Local build verified, VitePress preview confirms pages load correctly.
Closes #14