Skip to content

Initial commit: open-sourcing Warp docs#1

Merged
petradonka merged 1 commit intomainfrom
import/initial-content
Apr 30, 2026
Merged

Initial commit: open-sourcing Warp docs#1
petradonka merged 1 commit intomainfrom
import/initial-content

Conversation

@hongyi-chen
Copy link
Copy Markdown
Collaborator

Imports the full Warp docs content from warpdotdev/docs-internal to seed the new public-facing docs repository.

What's in this PR

The complete contents of warpdotdev/docs-internal at main@475160b (812 tracked files), including:

  • Site source: src/ (content, components, styles), public/, astro.config.mjs, vercel.json, package.json, package-lock.json, tsconfig.json
  • Open-source scaffolding: LICENSE (MIT), README.md, CONTRIBUTING.md, .github/PULL_REQUEST_TEMPLATE.md, .github/ISSUE_TEMPLATE/
  • Tooling: .github/workflows/ (CI, auto-review, comment bot), .trunk/, scripts/
  • Agent skills & docs: AGENTS.md, .warp/skills/, .warp/references/, .warp/rules/, .warp/templates/
  • API spec: developers/agent-api-openapi.yaml

The README and CONTRIBUTING.md already reference github.com/warpdotdev/docs, so no URL fixes were needed.

Approach

Single squashed commit (no docs-internal history is preserved). The destination repo had to be seeded with a LICENSE-only bootstrap commit on main first, since GitHub doesn't allow opening PRs against an empty repo.

Follow-ups (not blocking this merge)

  • secrets.WARP_API_KEY must be configured on warpdotdev/docs for .github/workflows/respond-to-comment.yml and review-pr.yml to run.
  • Once merged, configure branch protection, repo description, and topics as appropriate.
  • The repo is currently INTERNAL; flip to public when ready.

Artifacts

Co-Authored-By: Oz oz-agent@warp.dev

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>
@hongyi-chen hongyi-chen requested a review from bholmesdev April 30, 2026 18:40
Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.`;
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [IMPORTANT] [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):

Suggested change
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.

Comment thread .env.example
# 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=
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 [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:

Suggested change
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.

Comment thread CONTRIBUTING.md

## 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).
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 [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:

Suggested change
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).

@petradonka petradonka merged commit f5dcec8 into main Apr 30, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants