Enhance public API docs#1
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Summary
Railway docs reference
Inspected
railwayapp/docsfor API docs structure, especially its Public API overview, API cookbook, sidebar grouping, endpoint examples, request/response examples, code blocks, and tables. This PR borrows structure only; it does not copy Railway content.Validation
pnpm install --frozen-lockfilepnpm exec prettier --check content/docs/public-api.md content/docs/api/reference.md content/docs/api/cookbook.md content/docs-ko/public-api.md content/docs-ko/api/reference.md content/docs-ko/api/cookbook.md src/data/sidebar.ts src/data/sidebar-ko.tspnpm tscpnpm buildgit diff --check/public-api,/api/reference,/api/cookbook,/ko/public-api,/ko/api/reference,/ko/api/cookbook,/api/openapi.jsonall returned 200 onhttp://localhost:3001Notes
package.jsonwants Node 20 while this machine is on Node 25.2.1; build passes with the existing warning.@propertyrules remain non-fatal.