Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
57 changes: 0 additions & 57 deletions .github/workflows/docs-pr.yaml

This file was deleted.

13 changes: 0 additions & 13 deletions docs-v2/.env.example

This file was deleted.

38 changes: 0 additions & 38 deletions docs-v2/.gitignore

This file was deleted.

8 changes: 0 additions & 8 deletions docs-v2/.npmrc

This file was deleted.

2 changes: 0 additions & 2 deletions docs-v2/.tool-versions

This file was deleted.

21 changes: 0 additions & 21 deletions docs-v2/LICENSE

This file was deleted.

77 changes: 3 additions & 74 deletions docs-v2/README.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,5 @@
# Pipedream docs

> [!WARNING]
> **⚠️ THIS PROJECT IS DEPRECATED ⚠️**
>
> This docs-v2 directory is no longer maintained. Do not make changes to files in this directory as they will not be deployed or used.
>
> The documentation has been moved to a new location. Please contact the team for the current documentation repository.
## Quickstart

[Install `asdf`](https://asdf-vm.com/guide/getting-started.html) if you haven't already.

```bash
asdf install
pnpm dev
```

Open [http://localhost:3000/docs](http://localhost:3000/docs).

We use [Nextra](https://nextra.site/docs), [a Next.js app](https://nextjs.org/docs). Nextra builds docs from the `pages/` directory. All docs are [MDX](https://mdxjs.com/) files (Markdown with React components / JSX).

Run `yarn build` before pushing to your branch to confirm everything builds OK.

## VuePress -> Nextra

We're moving from VuePress to Nextra. Here's what's the same and what's different:

- New docs are here, in the `docs-v2/` directory.
- All docs are still Markdown. Now MDX files instead of just Markdown, so extensions have been renamed to `.mdx`.
- Keep images in `public/images/foo.png`, reference with `![alt text](/images/foo.png)`
- Leaf nodes in VuePress were at files like `/docs/workflows/workspaces/sso/google/README.md`. Nextra allows leaf nodes to be non-index files like `/docs/workflows/workspaces/sso/google.mdx`, so there's no need for the final directory, which simplifies things.
- VuePress used Vue, Nextra uses React. All of the custom components used in MDX files are either [built-in Nextra components](https://nextra.site/docs/guide/built-ins) or Pipedream-specific components in `components/`, ported from Vue.
- Learn the [built-in Nextra components](https://nextra.site/docs/guide/built-ins). All the `::: tip`, `::: warning`, or other special VuePress components have an equivalent Nextra component.

## Nextra

We use the [Nextra Docs Theme](https://nextra.site/docs/docs-theme/start), which adds functionality on the base Nextra app. Most of the features we use are well-documented there.

The [Nextra docs](https://nextra.site/docs) and [GitHub](https://github.com/shuding/nextra) are great. Anything not specific to Nextra is likely a feature of [Next.js](https://nextjs.org/docs) or [MDX](https://mdxjs.com/), also well-maintained and modern projects as of 2024.

Check `theme.config.tsx` for the latest config.

### Useful Nextra components

We use almost all of [the Nextra built-in components](https://nextra.site/docs/guide/built-ins) in docs.

### Adding new pages / routes

Nextra and Next.js tie routing closer to the directory structure of the app:

```
pages
index.mdx # /docs
data-stores.mdx # /docs/data-stores
http.mdx # /docs/http
workspaces/
index.mdx # /docs/workspaces
sso/
index.mdx # /docs/workflows/workspaces/sso
google.mdx # /docs/workflows/workspaces/sso/google
```

The `_meta.tsx` files in each directory defines a mapping between the labels in the sidebar and the files in that directory. If you want to add an item to the sidebar, you'll probably want to edit the `_meta.tsx` file. [See the Nextra docs](https://nextra.site/docs/docs-theme/page-configuration) for more info.

## Custom components

Use (and create!) custom components in `components/`. You'll see a lot of references to these components in the MDX.

## Redirects

If you need to add any custom redirects, e.g. when you move pages to a different directory, add then to the `vercel.json` file in this directory.

## Adding new versions

Add a new version of docs by creating a new feature branch in the format of `docs-v{number}-pathing`.
> [!WARNING] > **⚠️ THIS PROJECT IS DEPRECATED ⚠️**
>
> Pipedream public docs have moved to a new repo. Please contact the team for the current documentation repository.
Comment on lines +3 to +5
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Double-check for dead links to docs-v2 across the repo before merging

Removing docs-v2 can break internal links and CI references. Run this to find any remaining references and decide whether to update or remove them.


🏁 Script executed:

#!/bin/bash
# Find references to docs-v2 paths and pages
rg -nP -C2 '(?:^|/|")docs-v2(?:/|")' -g '!**/node_modules/**' -g '!**/dist/**' -g '!**/build/**'

# Find Markdown links pointing into docs-v2
rg -nP -C2 '\[[^\]]*\]\((?:\./|\.\./|/)?docs-v2/[^)]+\)' -g '!**/node_modules/**'

# Optional: find GitHub Actions or scripts referencing docs-v2
rg -nP -C2 'docs-?v2' .github/ || true

Length of output: 981


Remove residual docs-v2 references from lint config and CI workflows

There are still hardcoded docs-v2 patterns in your ESLint config and GitHub Actions workflow that need to be removed or updated now that the directory is gone:

eslint.config.mjs (around line 335)
Current:

  files: [
    "docs-v2/**/*.{js,jsx,ts,tsx}",
    // …
  ],

Suggestion: remove the "docs-v2/**/*.{js,jsx,ts,tsx}" entry (or replace with the new docs path if applicable).

.github/workflows/publish-packages.yaml (lines 7 and 13)
Current:

paths-ignore:
  - 'docs/**'
  - 'docs-v2/**'

Suggestion: delete the - 'docs-v2/**' line (and ensure you’re still ignoring any intended docs paths).

These changes are required to prevent ESLint from erroring on a non-existent directory and to keep your CI workflow clean.

🤖 Prompt for AI Agents
In docs-v2/README.md around lines 3 to 5: update project-wide configs to remove
hardcoded docs-v2 references; specifically edit eslint.config.mjs (around line
~335) to remove the "docs-v2/**/*.{js,jsx,ts,tsx}" entry (or replace it with the
correct new docs path), and edit .github/workflows/publish-packages.yaml (around
lines 7 and 13) to delete the '- 'docs-v2/**'' entry from paths-ignore (ensuring
other intended docs ignores remain), then run lint/CI locally to confirm no
references to docs-v2 remain.

89 changes: 0 additions & 89 deletions docs-v2/components/AccountConnectionDemo.jsx

This file was deleted.

Loading
Loading