Initial commit: open-sourcing Warp docs#1
Conversation
Imports the full Warp docs content from warpdotdev/docs-internal so the public docs repository can be open-sourced. Co-Authored-By: Oz <oz-agent@warp.dev>
There was a problem hiding this comment.
This PR seeds the new public warpdotdev/docs repo with the full docs-internal tree (812 files). The content is imported wholesale, so the bulk is unchanged — the open-source scaffolding (README, CONTRIBUTING, LICENSE, issue/PR templates, workflows, .env.example) is what's specifically new for this initial commit and is in good shape: README and CONTRIBUTING are clear, the MIT LICENSE is in place, the issue templates are well-structured, and the internal link checker passes (0 broken across 2,352 internal links in 307 markdown files). External links to warpdotdev/oz-skills, warpdotdev/.github (CODE_OF_CONDUCT, SECURITY), oz.warp.dev, and warp.dev/{code,agents} all return 200.
One small but user-visible issue in .github/workflows/respond-to-comment.yml: the agent-error fallback comment contains a malformed Markdown link ([workflow run logs] with no URL), so anyone who triggers a failure will see literal brackets in the PR comment instead of a link. A couple of low-priority suggestions on .env.example and CONTRIBUTING.md below.
Found: 0 critical, 1 important, 2 suggestions, 0 nits
Recommendation: Approve with nits — the malformed link is worth fixing in a follow-up but not blocking for the initial open-source seed PR.
| with: | ||
| github-token: ${{ github.token }} | ||
| script: | | ||
| const body = `@${context.payload.comment.user.login}: ⚠️ I encountered an error while processing your request. Please check the [workflow run logs] for more details.`; |
There was a problem hiding this comment.
[workflow run logs] is a malformed Markdown link — there's no (URL) part, so when this fallback fires, the GitHub comment will render the literal text [workflow run logs] (brackets and all) instead of a clickable link to the failing run.
Either inline a real run URL, or drop the brackets if a link is overkill. Suggested fix (constructs the run URL from the script context, which is already available without extra imports):
| const body = `@${context.payload.comment.user.login}: ⚠️ I encountered an error while processing your request. Please check the [workflow run logs] for more details.`; | |
| const { owner, repo } = context.repo; | |
| const runUrl = `${context.serverUrl}/${owner}/${repo}/actions/runs/${context.runId}`; | |
| const body = `@${context.payload.comment.user.login}: ⚠️ I encountered an error while processing your request. Please check the [workflow run logs](${runUrl}) for more details.`; |
Note that this also moves the const { owner, repo } = context.repo; line up by one, so the existing line 232 (const { owner, repo } = context.repo;) below should be removed to avoid a redeclaration error.
| # PushFeedback project ID for the per-page "Was this helpful?" widget and the | ||
| # feedback widget on the Scalar API page. If unset, both widgets are hidden. | ||
| # Dashboard: https://app.pushfeedback.com | ||
| PUBLIC_PUSHFEEDBACK_PROJECT_ID= |
There was a problem hiding this comment.
💡 [SUGGESTION] astro.config.mjs defines four optional public env fields, but only two appear here — PUBLIC_RUDDERSTACK_WRITE_KEY and PUBLIC_RUDDERSTACK_DATA_PLANE_URL are missing. If those are intentionally omitted because they're for Warp's production analytics and not meant for OSS contributors, a one-line comment in this file would prevent the next person from grepping astro.config.mjs and wondering whether it's an oversight. Something like:
| PUBLIC_PUSHFEEDBACK_PROJECT_ID= | |
| PUBLIC_PUSHFEEDBACK_PROJECT_ID= | |
| # PUBLIC_RUDDERSTACK_WRITE_KEY and PUBLIC_RUDDERSTACK_DATA_PLANE_URL are | |
| # defined in astro.config.mjs for production analytics on docs.warp.dev | |
| # and are intentionally not listed here — local builds don't need them. |
|
|
||
| ## Open a pull request | ||
|
|
||
| Create a focused pull request from your fork using the repository's [pull request template](https://github.com/warpdotdev/docs/blob/main/.github/PULL_REQUEST_TEMPLATE.md). |
There was a problem hiding this comment.
💡 [SUGGESTION] The PR template link uses an absolute github.com/warpdotdev/docs/... URL while the rest of this file references in-repo files by relative path (e.g., AGENTS.md, .warp/skills/create_pr/SKILL.md two lines down on line 112). A relative path would be consistent and would also work for forks / future repo renames:
| Create a focused pull request from your fork using the repository's [pull request template](https://github.com/warpdotdev/docs/blob/main/.github/PULL_REQUEST_TEMPLATE.md). | |
| Create a focused pull request from your fork using the repository's [pull request template](.github/PULL_REQUEST_TEMPLATE.md). |
Imports the full Warp docs content from
warpdotdev/docs-internalto seed the new public-facing docs repository.What's in this PR
The complete contents of
warpdotdev/docs-internalatmain@475160b(812 tracked files), including:src/(content, components, styles),public/,astro.config.mjs,vercel.json,package.json,package-lock.json,tsconfig.jsonLICENSE(MIT),README.md,CONTRIBUTING.md,.github/PULL_REQUEST_TEMPLATE.md,.github/ISSUE_TEMPLATE/.github/workflows/(CI, auto-review, comment bot),.trunk/,scripts/AGENTS.md,.warp/skills/,.warp/references/,.warp/rules/,.warp/templates/developers/agent-api-openapi.yamlThe README and CONTRIBUTING.md already reference
github.com/warpdotdev/docs, so no URL fixes were needed.Approach
Single squashed commit (no
docs-internalhistory is preserved). The destination repo had to be seeded with aLICENSE-only bootstrap commit onmainfirst, since GitHub doesn't allow opening PRs against an empty repo.Follow-ups (not blocking this merge)
secrets.WARP_API_KEYmust be configured onwarpdotdev/docsfor.github/workflows/respond-to-comment.ymlandreview-pr.ymlto run.INTERNAL; flip to public when ready.Artifacts
Co-Authored-By: Oz oz-agent@warp.dev