-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Removing docs-v2 from the repo #18183
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
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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 |
|---|---|---|
| @@ -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 `` | ||
| - 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. | ||
This file was deleted.
Oops, something went wrong.
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.
💡 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:
Length of output: 981
Remove residual docs-v2 references from lint config and CI workflows
There are still hardcoded
docs-v2patterns 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:
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:
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