Skip to content

Commit

Permalink
📝 (admin) add admin docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tahul committed May 9, 2021
1 parent 2a81227 commit f318272
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/pages/2.usage/5.admin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Admin

:::alert{type="info"}
Admin is currently under development. Informations below are related to developer experience for the Admin UI.
:::

Admin application is a **Vue 3** app built aside from the current app.

This app exposes an **HTTP API** allowing to perform **read/write** operations on the current project files and directories.

The Docs app is rendered via an `iframe`, content updates are so reflected using **Docus core** and **WebSockets**.

## Start the UI

The admin UI can be launched without the Docs repository, using a command.

```bash
yarn dev:admin
```

1 comment on commit f318272

@vercel
Copy link

@vercel vercel bot commented on f318272 May 9, 2021

Choose a reason for hiding this comment

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

Please sign in to comment.