diff --git a/docs/panel/advanced/api-docs.mdx b/docs/panel/advanced/api-docs.mdx new file mode 100644 index 00000000..b3d340db --- /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. + + + You must sign in on the login page **before** accessing the docs. + + +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 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 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', ] }