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

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .npmrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
auto-install-peers=true
enable-pre-post-scripts=true
save-workspace-protocol=false
link-workspace-packages=false
link-workspace-packages=false
shamefully-hoist=true
node-linker=hoisted
shared-workspace-lockfile=true
engine-strict=false
8 changes: 8 additions & 0 deletions docs-v2/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
auto-install-peers=true
enable-pre-post-scripts=true
save-workspace-protocol=false
link-workspace-packages=false
shamefully-hoist=true
node-linker=hoisted
shared-workspace-lockfile=true
engine-strict=false
6 changes: 2 additions & 4 deletions docs-v2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@

```bash
asdf install
yarn install
yarn dev
pnpm dev
```

Open [http://localhost:3000/docs](http://localhost:3000/docs).
Expand Down Expand Up @@ -55,7 +54,7 @@ pages
google.mdx # /docs/workspaces/sso/google
```

The `_meta.json` 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.json` file. [See the Nextra docs](https://nextra.site/docs/docs-theme/page-configuration) for more info.
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

Expand All @@ -65,7 +64,6 @@ Use (and create!) custom components in `components/`. You'll see a lot of refere

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`.
1 change: 1 addition & 0 deletions docs-v2/components/DocSearch.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ function Search() {
facetFilters: [
"version:latest",
],
indexName: process.env.ALGOLIA_INDEX_NAME,
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Remove redundant indexName parameter

The indexName is already provided as a top-level prop to the DocSearch component. Adding it again in searchParameters is redundant and potentially confusing.

      searchParameters={{
        facetFilters: [
          "version:latest",
        ],
-       indexName: process.env.ALGOLIA_INDEX_NAME,
      }}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
indexName: process.env.ALGOLIA_INDEX_NAME,
indexName: process.env.ALGOLIA_INDEX_NAME,

}}
transformItems={(items) => {
return items.map((item) => ({
Expand Down
2 changes: 1 addition & 1 deletion docs-v2/components/PipedreamCode.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const fira = Fira_Code({
});

const PipedreamCode = ({ children }: PipedreamCodeProps) => <>
<code className={`${fira.className} dark:text-white`}>{children}</code>
<code className={`${fira.className} dark:text-white p-2`}>{children}</code>
</>;

export default PipedreamCode;
6 changes: 4 additions & 2 deletions docs-v2/next.config.js → docs-v2/next.config.mjs
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
const withNextra = require("nextra")({
import nextra from "nextra";

const withNextra = nextra({
theme: "nextra-theme-docs",
themeConfig: "./theme.config.tsx",
defaultShowCopyCode: true,
});

module.exports = withNextra({
export default withNextra({
basePath: "/docs",
images: {
remotePatterns: [
Expand Down
Loading
Loading