User Guide - init

Author: Philipinho

docs/user-guide/_category_.json

@@ -0,0 +1,5 @@
+{
+  "label": "User Guide",
+  "position": 3,
+  "collapsed": false
+}

docs/user-guide/authentication/_category_.json

@@ -0,0 +1,5 @@
+{
+  "label": "Authentication",
+  "position": 2,
+  "collapsed": true
+}

docs/user-guide/authentication/index.md

@@ -0,0 +1,12 @@
+import DocCardList from '@theme/DocCardList';
+
+# Authentication
+Authentication in Docmost ensures secure and efficient access management, providing flexibility for users and administrators alike. 
+
+Authentication methods in Docmost include:
+- Email and Password Authentication
+- SSO (SAML/OIDC) (available in Cloud and Enterprise edition)
+
+
+<DocCardList />
+

docs/user-guide/authentication/oidc.md

@@ -0,0 +1,39 @@
+---
+sidebar_position: 3
+---
+
+# OIDC
+**Edition:** Enterprise
+
+Docmost supports authentication through OpenID Connect (OIDC), allowing integration with any identity provider that supports the OIDC standard.
+
+<p align="center">
+<img src="/docs/img/oidc-auth.png" width="350"/>
+</p>
+
+### How to configure OpenID Connect (OIDC):
+
+1. **Navigate to Security Settings**
+    - Go to **Settings** → **Security & SSO** in your Docmost dashboard.
+
+2. **Create a New SSO Integration**
+    - Click on the **"Create SSO"** button.
+    - Select **"OpenID (OIDC)"** from the dropdown menu. This opens a configuration popup.
+
+3. **Configure Your OIDC Integration**
+    - Enter a descriptive **Display Name** for this integration (e.g., "Company SSO").
+    - Copy the provided **Callback URL**. You’ll need to add this URL to your OIDC provider’s allowed redirect URIs.
+
+4. **Enter Your OIDC Provider Details**
+    - **Issuer URL:** Provide the Issuer URL from your OIDC provider.
+    - **Client ID:** Paste the Client ID obtained from your OIDC provider.
+    - **Client Secret:** Paste the Client Secret obtained from your OIDC provider.
+
+5. **Additional Configuration Options**
+    - To automatically provision users upon their first login, enable the **"Allow Signup"** toggle.
+    - To activate this integration immediately, enable the **"Enabled"** toggle.
+
+6. **Save Your Configuration**
+    - Click **"Save"** to apply your settings.
+
+After successful configuration, your OIDC provider will appear as an available login method on the Docmost login page. Users can now authenticate through your configured OIDC integration.

docs/user-guide/authentication/saml.md

@@ -0,0 +1,43 @@
+---
+sidebar_position: 2
+tags:
+   - Enterprise
+---
+
+# SAML
+
+**Edition:** Enterprise
+
+Docmost supports authentication via the Security Assertion Markup Language (SAML 2.0), allowing integration with identity providers (IdPs) that support the SAML protocol.
+
+### How to configure SAML 2.0
+
+1. **Navigate to Security Settings**
+   - Go to **Settings** → **Security & SSO** in your Docmost dashboard.
+
+2. **Create a New SSO Integration**
+   - Click on the **"Create SSO"** button.
+   - Select **"SAML"** from the dropdown menu. This opens a configuration popup.
+
+3. **Configure Your SAML Integration**
+   - Provide a descriptive **Display Name** for this integration (e.g., "Company SAML SSO").
+
+4. **Configure Your Identity Provider (IdP)**
+   - From Docmost, copy the following fields into your IdP’s configuration:
+      - **Entity ID:** Docmost’s unique identifier provided in the configuration popup.
+      - **Callback URL (ACS):** Assertion Consumer Service URL provided by Docmost.
+
+   Ensure these URLs are correctly configured in your Identity Provider settings.
+
+5. **Enter Your Identity Provider (IdP) Details in Docmost**
+   - **IDP Login URL:** Paste the login URL from your IdP, which users will be redirected to for authentication.
+   - **IDP Certificate:** Paste your IdP’s public X.509 certificate text.
+
+6. **Additional Configuration Options**
+   - To automatically provision users on first login, enable the **"Allow Signup"** option.
+   - Activate this integration immediately by toggling **"Enabled"**.
+
+7. **Save Your Configuration**
+   - Click **"Save"** to finalize your settings.
+
+Once successfully configured, your SAML 2.0 provider will appear on Docmost's login page, allowing users to authenticate via your configured Identity Provider.

docs/user-guide/groups.md

@@ -0,0 +1,83 @@
+---
+sidebar_position: 5
+---
+
+# Groups
+
+Groups are a way to manage user permissions collectively. Instead of assigning roles and privileges to individual users, you can assign them to a group, simplifying access control across your workspace.  
+
+There is a default group called **Everyone**. All users are automatically part of this group.
+
+### Who Can Manage Groups?
+
+Only users with **Admin** or **Owner** roles can create, edit, or delete groups and manage group memberships.
+
+### Creating a Group
+
+1. Go to **Workspace Settings**.
+2. Click on **Groups** in the sidebar.
+3. Click the **Create Group** button at the top right.
+4. In the popup:
+    - Enter a **Group Name** (e.g., `Sales`).
+    - Add an optional **Description**.
+    - Use the **search box** to find and add members (You can always add more members later).
+5. Click **Create** to finish.
+6. You’ll be redirected to the new group’s page to review or manage its members.
+
+### Grant Group access to a Space
+
+A **Space** is a dedicated area within your workspace for organizing pages, and collaboration. It helps teams separate content by project or department. Learn more in the [Spaces Documentation](./spaces).
+
+After creating a group, you may want to grant it access to specific Spaces. Doing so allows all group members to inherit access to that Space with a unified role.
+
+1. Navigate to the **Space** you want to manage.
+2. Click on **Space Settings**.
+3. Go to the **Members** tab.
+4. Click **Add Space Members**.
+5. In the popup:
+    - Search for the group name.
+    - Select a permission level:
+        - **Full Access** – full admin control within the space
+        - **Can Edit** – can edit pages and content
+        - **Can View** – read-only access
+    - Click **Add** to confirm.
+
+The group will now appear in the Space members list with the assigned permission level.
+> **Note:** If a user has multiple paths of access to a Space (e.g., both individually and through a group), the **highest permission level** will apply.
+
+
+### Adding Members to a Group
+
+1. Go to **Settings > Groups**.
+2. Select the group.
+3. Click the **Add Members** button.
+4. Search for users and add them to the group.
+
+### Removing a User from a Group
+
+1. Go to **Settings > Groups**.
+2. Select the group.
+3. Locate the member you want to remove.
+4. Click the **three dots (⋯)** next to their name.
+5. Select **Remove Group Member**.
+6. Confirm the action.
+
+### Editing a Group
+
+1. Go to **Settings > Groups**.
+2. Select the group.
+3. Click the **three dots (⋯)** in the top right.
+4. Choose **Edit Group**.
+5. Update the group name and/or description.
+6. Save your changes.
+
+### Deleting a Group
+
+1. Go to **Settings > Groups**.
+2. Select the group.
+3. Click the **three dots (⋯)** in the top right.
+4. Choose **Delete Group**.
+5. Confirm the deletion.
+
+
+

docs/user-guide/index.md

@@ -0,0 +1,5 @@
+import DocCardList from '@theme/DocCardList';
+
+# User Guide
+
+<DocCardList />

docs/user-guide/spaces.md

@@ -0,0 +1,105 @@
+---
+sidebar_position: 4
+---
+
+# Spaces
+
+Docmost **Spaces** are dedicated, organized areas within your workspace that group together documents, permissions, and collaborators by project, team, or purpose.
+
+Spaces act as top-level folders. Within a space, you can:
+- Move or copy pages between spaces
+- Create nested page hierarchies
+- Drag and drop pages in the sidebar
+- Import or export pages
+
+### Creating a Space
+To create a new space:
+
+1. Go to **Settings > Spaces**.
+2. Click the **Create Space** button in the top right.
+3. In the popup:
+    - Enter a **Space Name** (e.g., `Engineering`).
+    - Choose a custom **Space Slug**.
+    - Add an optional **Description**.
+4. Click **Create** to finish.
+5. You'll be redirected to the newly created space.
+
+> As the creator, you become the **Space Admin** with **Full Access** permissions.
+
+### Adding Members to a Space
+
+To add members to a space:
+
+1. In the sidebar, click **Space Settings** for the space you want to manage.
+2. In the popup, go to the **Members** tab.
+3. Click **Add Space Members**.
+4. Search for individual workspace members or groups.
+5. Select a role and click **Add**.
+
+The available space roles are:
+- **Full Access:** Full control over settings, permissions, and pages.
+- **Can Edit:** Can create and modify pages within the space.
+- **Viewer:** Can view pages, but cannot edit.
+
+### Removing a Member from a Space
+
+To remove someone from a group:
+
+1. Go to **Settings > Groups**.
+2. Select the group.
+3. Find the member you want to remove.
+4. Click the **three dots (⋯)** next to their name.
+5. Select **Remove Space Member**.
+6. Confirm the action.
+
+
+### Editing a Space
+
+To update a space’s details:
+
+1. Go to **Settings > Spaces**.
+2. Select the space.
+3. In the popup, switch to the **Settings** tab.
+4. Edit the **name**, **slug**, or **description**.
+5. Click **Save** to apply changes.
+
+### Exporting a Space
+
+You can export pages and attachments within a space for backup, migration, or offline use. Docmost provides both Markdown and HTML export formats.
+
+  <p align="center">
+<img src="/docs/img/space-settings.png" width="500"/>
+</p>
+
+To export a space,
+
+1. Navigate to the **Space Settings**.
+
+2. Within **Space Settings**, select the **Settings** tab at the top.
+
+3. Click the **Export** button to initiate the export process.
+
+  <p align="center">
+<img src="/docs/img/export-space.png" width="500"/>
+</p>
+
+4. In the export dialog:
+   - Select your desired export format: **Markdown** or **HTML**.
+   - Toggle the **Include attachments** option if you want to export attached files along with your content.
+
+5. Click the **Export** button to start downloading.
+
+The exported content will be bundled into a ZIP file and automatically downloaded to your device. You can then extract and use it according to your needs.
+
+### Deleting a Space
+
+To permanently delete a space:
+
+1. Open the space’s **Settings**.
+2. Switch to the **Settings** tab.
+3. Click the **Delete** button.
+4. In the confirmation dialog:
+   - Type the space name to confirm.
+   - Click **Confirm**.
+
+> ⚠️ This action is irreversible. The space and all its content will be permanently deleted.

docs/user-guide/translations.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 12
+---
+# Translations
+
+Docmost is built for global teams and communities. The platform is available in over 12 languages, making it accessible to users across regions and industries.
+
+Supported languages include:
+
+🇺🇸 English  
+🇨🇳 Chinese  
+🇫🇷 French  
+🇩🇪 German  
+🇮🇹 Italian  
+🇯🇵 Japanese  
+🇰🇷 Korean  
+🇧🇷 Portuguese  
+🇷🇺 Russian  
+🇪🇸 Spanish  
+🇳🇱 Dutch  
+🇺🇦 Ukrainian
+
+Language settings can be managed by each user from the "Settings > Preferences" page, ensuring each person sees the UI in their preferred language.
+
+<p align="center">
+<img src="/docs/img/user-preference.png" width="800"/>
+</p>
+
+Translations are maintained and improved via the Crowdin platform. This means anyone can help improve the language translations.
+To join the translation effort:
+👉 [Docmost Crowdin Project](https://crowdin.com/project/docmost)

docs/user-guide/workspace.md

@@ -0,0 +1,29 @@
+---
+sidebar_position: 3
+---
+
+# Workspace
+In **Docmost**, a **workspace** serves as the primary container for organizing your documentation and collaboration efforts. It encompasses all your content, user roles, and permissions. Within a workspace, you can create multiple **spaces** to categorize and manage information related to different teams, projects, or departments.
+
+### Workspace Structure
+
+- **Workspace**: The top-level entity that houses all your documentation.
+- **Spaces**: Subdivisions within a workspace, each dedicated to a specific team, project, or department.
+- **Pages**: Individual documents residing within spaces.
+
+> This hierarchical structure — `Workspace → Space → Page` — facilitates organized and efficient content management.
+
+### User Roles and Permissions
+
+Within a workspace, users can be assigned different roles:
+
+- **Owner**: Has full administrative control over the workspace.
+- **Admin**: Can manage spaces and users within the workspace.
+- **Member**: Has access to assigned spaces and can contribute content based on permissions.
+
+Each space within the workspace can define its own set of permissions:
+
+- **Full Access**: Can manage the space, including adding or removing members and editing content.
+- **Can Edit**: Can modify content within the space but cannot manage members.
+- **Can View**: Read-only access to the space's content.
+