From 8faa413bb04ebd446309530408dd45d5f4ebab8f Mon Sep 17 00:00:00 2001 From: Beijing-corn87 <111331826+bluekiwidev@users.noreply.github.com> Date: Tue, 21 Apr 2026 19:49:02 +1200 Subject: [PATCH 1/3] Added a page for documenting where to find the api docs --- docs/panel/advanced/api-docs.mdx | 20 ++++++++++++++++++++ sidebars.ts | 1 + 2 files changed, 21 insertions(+) create mode 100644 docs/panel/advanced/api-docs.mdx diff --git a/docs/panel/advanced/api-docs.mdx b/docs/panel/advanced/api-docs.mdx new file mode 100644 index 00000000..c5c04bac --- /dev/null +++ b/docs/panel/advanced/api-docs.mdx @@ -0,0 +1,20 @@ +import Admonition from '@theme/Admonition'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# API docs +The docs for the Pelican API can be found by going to ```/docs/api``` on your panel address. + + + You will need to sign in **before** accessing the docs on the login page + + +For example: +```bash +https://yourpaneladdress.com/docs/api +``` + +You can also visit the docs on the demo instance [here](https://demo.pelican.dev/docs/api). + +There are two types of API you can interact with. The first is the Application API. The application API is used more for adjusting the server configuration. +The second is the client API. This API is more for interacting with the features that users normally interact with. \ No newline at end of file diff --git a/sidebars.ts b/sidebars.ts index c2e0ad7f..403113dd 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -31,6 +31,7 @@ const sidebars: SidebarsConfig = { 'panel/advanced/mysql', 'panel/advanced/artisan', 'panel/advanced/docker', + 'panel/advanced/api-docs', 'panel/advanced/plugins', ] } From 71cb1290947dfe660fcf93a798b79f832a1bc798 Mon Sep 17 00:00:00 2001 From: Beijing-corn87 <111331826+bluekiwidev@users.noreply.github.com> Date: Tue, 21 Apr 2026 20:35:43 +1200 Subject: [PATCH 2/3] Changed triple backticks to single backticks --- docs/panel/advanced/api-docs.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/panel/advanced/api-docs.mdx b/docs/panel/advanced/api-docs.mdx index c5c04bac..30b5de9c 100644 --- a/docs/panel/advanced/api-docs.mdx +++ b/docs/panel/advanced/api-docs.mdx @@ -3,10 +3,10 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; # API docs -The docs for the Pelican API can be found by going to ```/docs/api``` on your panel address. +The docs for the Pelican API can be found by going to `/docs/api` on your panel address. - You will need to sign in **before** accessing the docs on the login page + You will need to sign in **before** accessing the docs on the login page. For example: From 10467803bc42accb4cfab480245a9d756295d19b Mon Sep 17 00:00:00 2001 From: Beijing-corn87 <111331826+bluekiwidev@users.noreply.github.com> Date: Tue, 21 Apr 2026 20:37:32 +1200 Subject: [PATCH 3/3] Fixed some wording to be better understood --- docs/panel/advanced/api-docs.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/panel/advanced/api-docs.mdx b/docs/panel/advanced/api-docs.mdx index 30b5de9c..b3d340db 100644 --- a/docs/panel/advanced/api-docs.mdx +++ b/docs/panel/advanced/api-docs.mdx @@ -3,10 +3,10 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; # API docs -The docs for the Pelican API can be found by going to `/docs/api` on your panel address. +The docs for the Pelican API can be found by going to `/docs/api` on your panel. - You will need to sign in **before** accessing the docs on the login page. + You must sign in on the login page **before** accessing the docs. For example: @@ -16,5 +16,5 @@ https://yourpaneladdress.com/docs/api You can also visit the docs on the demo instance [here](https://demo.pelican.dev/docs/api). -There are two types of API you can interact with. The first is the Application API. The application API is used more for adjusting the server configuration. +There are two APIs you can interact with. The first is the Application API. The application API is used more for adjusting the server configuration. The second is the client API. This API is more for interacting with the features that users normally interact with. \ No newline at end of file