Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
foyarash committed Oct 3, 2024
1 parent 3386985 commit 363ea53
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 23 deletions.
24 changes: 12 additions & 12 deletions apps/docs/pages/docs/api/create-handler-function.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

import { Callout, Tabs } from "nextra/components";
import OptionsTable from "../../../components/OptionsTable";

# `createHandler` function

<Callout type="info">
This is the documentation for the latest version of Next Admin. If you are using an older version (`<5.0.0`), please refer to the [documentation](/v4/docs)
</Callout>
Expand All @@ -12,21 +12,21 @@ import OptionsTable from "../../../components/OptionsTable";
<OptionsTable
options={[
{
name: 'prisma',
description: 'Your Prisma client instance. This is mandatory.'
},
{
name: 'schema',
description: 'Your JSON Schema generated by Prisma. This is mandatory.'
name: "prisma",
description: "Your Prisma client instance. This is mandatory.",
},
{
name: 'onRequest',
description: 'A function that is executed before any request. Useful for authentication.'
name: "onRequest",
description:
"A function that is executed before any request. Useful for authentication.",
},
{
name: 'options',
description: <>Your Next Admin <a href="/docs/api/options">options</a> - optional. </>
name: "options",
description: (
<>
Your Next Admin <a href="/docs/api/options">options</a> - optional.{" "}
</>
),
},

]}
/>
13 changes: 3 additions & 10 deletions apps/docs/pages/docs/api/get-next-admin-props-function.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

import { Callout, Tabs } from "nextra/components";
import OptionsTable from "../../../components/OptionsTable";

# `getNextAdminProps` function

<Callout type="info">
This is the documentation for the latest version of Next Admin. If you are using an older version (`<5.0.0`), please refer to the [documentation](/v4/docs)
</Callout>
Expand Down Expand Up @@ -31,10 +31,6 @@ import OptionsTable from "../../../components/OptionsTable";
name: 'apiBasePath',
description: 'The base path of your admin API. It is used to build the admin API URL. It is mandatory.'
},
{
name: 'schema',
description: <>The JSON schema generated by the <code>prisma generate</code> command.</>
},
{
name: 'prisma',
description: 'Your Prisma client instance.'
Expand Down Expand Up @@ -70,10 +66,6 @@ import OptionsTable from "../../../components/OptionsTable";
name: 'apiBasePath',
description: <>The base path of your admin API. It is used to build the admin API URL. It is optional and defaults to <code>/api/admin</code>.</>
},
{
name: 'schema',
description: <>The JSON schema generated by the <code>prisma generate</code> command.</>
},
{
name: 'prisma',
description: 'Your Prisma client instance.'
Expand All @@ -94,8 +86,9 @@ import OptionsTable from "../../../components/OptionsTable";
name: 'options',
description: <>The <a href="/docs/api/options">options</a> object - optional.</>
}

]}
/>

</Tabs.Tab>
</Tabs>
3 changes: 2 additions & 1 deletion apps/docs/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ import { FeaturesBento } from "@/components/bento/FeaturesBento";
<div className="mx-auto flex max-w-4xl flex-col gap-10">
<Subtitle>Getting Started</Subtitle>
<div className="mx-auto inline-block rounded-md bg-black px-5 py-3 font-mono text-white shadow-[0_10px_20px_rgba(230,253,238,1)] dark:shadow-[0_10px_20px_rgba(255,255,255,0.4)]">
yarn add @premieroctet/next-admin prisma-json-schema-generator
yarn add @premieroctet/next-admin
@premieroctet/next-admin-generator-prisma
</div>
</div>
<Subtitle>Features</Subtitle>
Expand Down

0 comments on commit 363ea53

Please sign in to comment.