-
Notifications
You must be signed in to change notification settings - Fork 7
Initial commit: open-sourcing Warp docs #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Copy to `.env` (or set via your shell) to enable optional integrations. | ||
| # `.env`, `.env.local`, and `.env.production` are all gitignored. | ||
| # | ||
| # Both of these values are PUBLIC (they're shipped to the browser by Astro's | ||
| # `envField`, and live behind rate limiting / allow-lists on the vendor side). | ||
|
|
||
| # Kapa Custom Frontend integration ID for the "Ask AI" button in the header. | ||
| # If unset, the Ask AI button is hidden and the site still runs normally. | ||
| # Get yours at: https://app.kapa.ai/admin | ||
| PUBLIC_KAPA_INTEGRATION_ID= | ||
|
|
||
| # 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= | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| name: "Docs site bug" | ||
| description: Report a problem with the docs website, not the documentation content. | ||
| labels: | ||
| - bug | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Issue description | ||
| description: Describe the problem you experienced while using the Warp Docs website. | ||
| placeholder: The page does not load, search is not working, navigation is broken, etc. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: pages | ||
| attributes: | ||
| label: Page or pages affected | ||
| description: Provide the URL of each page where the issue occurs. | ||
| placeholder: https://docs.warp.dev/getting-started/quickstart/installation-and-setup | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: Expected behavior | ||
| description: Describe what you expected to happen. | ||
| placeholder: I expected... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: actual | ||
| attributes: | ||
| label: Actual behavior | ||
| description: Describe what happened instead. | ||
| placeholder: Instead... | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: browser | ||
| attributes: | ||
| label: Browser | ||
| description: Include your browser and version if the issue appears browser-specific. | ||
| placeholder: Chrome 124, Safari 17, Firefox 125, etc. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: additional | ||
| attributes: | ||
| label: Additional context | ||
| description: Add screenshots, recordings, error messages, or other details that may help us investigate. | ||
| validations: | ||
| required: false |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| name: "Docs content issue" | ||
| description: Report incorrect, outdated, missing, or unclear documentation. | ||
| labels: | ||
| - improve or update documentation | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: "Minor fixes like typos, broken links, and short clarifications can go straight to a pull request." | ||
| - type: input | ||
| id: subject | ||
| attributes: | ||
| label: Subject area or topic | ||
| description: Which product area or documentation topic does this affect? | ||
| placeholder: Agent Mode, Warp Drive, cloud agents, API keys, billing, etc. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: pages | ||
| attributes: | ||
| label: Page or pages affected | ||
| description: Provide the URL of each affected page, or suggest where new content should live. | ||
| placeholder: https://docs.warp.dev/agent-platform/capabilities/skills | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: What is incorrect, outdated, missing, or unclear? | ||
| description: Describe the documentation problem and why it matters. | ||
| placeholder: This page says..., but the current behavior is... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: suggested | ||
| attributes: | ||
| label: Suggested update | ||
| description: Share the correction, source context, or proposed direction if you have one. | ||
| placeholder: The page should say... | ||
| validations: | ||
| required: false |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Ask the Warp community | ||
| url: https://go.warp.dev/join-preview | ||
| about: This issue tracker is not for support questions. Join the Warp community Slack for help. | ||
| - name: Read the contribution guide | ||
| url: https://github.com/warpdotdev/docs/blob/main/CONTRIBUTING.md | ||
| about: Learn how to contribute to Warp Docs. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| ## Summary | ||
|
|
||
| <!-- What changed and why? --> | ||
|
|
||
| ## Related issues | ||
|
|
||
| <!-- Link issues, discussions, or source context. Write "None" if this is a small fix. --> | ||
|
|
||
| ## Validation | ||
|
|
||
| <!-- List the checks you ran, or explain why a check was not run. --> | ||
|
|
||
| ## Screenshots | ||
|
|
||
| <!-- Optional. Add screenshots for visual changes like navigation, asset, or layout updates. --> | ||
|
|
||
| ## Follow-ups | ||
|
|
||
| <!-- Note any intentional follow-up work or out-of-scope items. --> |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| pull_request: | ||
| push: | ||
| branches: [main] | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| build: | ||
| name: Build, link-check, audit | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '22' | ||
| cache: 'npm' | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.12' | ||
|
|
||
| - name: Install dependencies | ||
| run: npm ci | ||
|
|
||
| - name: Type-check | ||
| run: npm run typecheck | ||
|
|
||
| - name: Build site | ||
| run: npm run build | ||
|
|
||
| - name: Check internal links | ||
| run: python3 .warp/skills/check_for_broken_links/check_links.py --internal-only | ||
|
|
||
| # Production-only audit; gate on high+ so dev-only deprecation chatter | ||
| # doesn't break PRs. The `|| true` keeps it informational; tighten this | ||
| # to a hard fail once we're confident the noise is gone. | ||
| - name: npm audit (production deps) | ||
| run: npm audit --omit=dev --audit-level=high || true |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 [SUGGESTION]
astro.config.mjsdefines four optional public env fields, but only two appear here —PUBLIC_RUDDERSTACK_WRITE_KEYandPUBLIC_RUDDERSTACK_DATA_PLANE_URLare 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 greppingastro.config.mjsand wondering whether it's an oversight. Something like: