Merge pull request #503 from Harbour-Enterprises/feature/har-9685-superdoc-update-docs-documentmode

docs: update docs with proper documentMode + file format

Author: harbournick

docs/src/components/index.md

@@ -49,7 +49,8 @@ const superdoc = new SuperDoc({
 | `selector`     | `string\|Element` | CSS selector or DOM element where SuperDoc will be rendered |    ✓     | -                |
 | `documents`    | `array`           | Array of document objects to load                           |    ✓     | -                |
 | `superdocId`   | `string`          | Unique identifier for this SuperDoc instance                |          | Random UUID      |
-| `documentMode` | `string`          | Initial mode: 'viewing' or 'editing'                        |          | 'viewing'        |
+| `documentMode` | `string`          | Document mode: 'viewing', 'suggesting', or 'editing'         |          | 'editing'        |
+| `role`         | `string`          | User role: 'editor', 'suggester', or 'viewer'               |          | 'editor'         |
 | `user`         | `object`          | Current user information                                    |          | {}               |
 | `toolbar`      | `string\|Element` | DOM element to render toolbar                               |          | Internal toolbar |
 | `modules`      | `object`          | Additional modules configuration                            |          | {}               |
@@ -91,7 +92,7 @@ modules: {
 | Method                                | Parameters                        | Return          | Description                                                 |
 | :------------------------------------ | :-------------------------------- | :-------------- | :---------------------------------------------------------- |
 | `export()`                            | -                                 | `Promise<Void>` | Exports the SuperDocs and triggers download                 |
-| `setDocumentMode(mode)`               | mode: 'viewing' or 'editing'      | -               | Switches between view and edit modes                        |
+| `setDocumentMode(mode)`               | mode: 'viewing', 'suggesting', or 'editing'      | -               | Switches between view, suggest, and edit modes                        |
 | `on(event, callback)`                 | event: string, callback: function | -               | Registers an event listener                                 |
 | `off(event, callback)`                | event: string, callback: function | -               | Removes an event listener                                   |
 | `getHTML()`                           | -                                 | -               | Get a list of HTML strings (one per DOCX document)          |
@@ -103,7 +104,7 @@ modules: {
 | onEditorBeforeCreate | -                         | Called **before** the document editor is created.       |
 | onEditorCreate       | `{ editor }`              | Called when the document editor is created.             |
 | onEditorDestroy      | -                         | Called when the document editor is destroyed.           |
-| onContentError       | `{ error, editor }`       | Called when there’s an error with document content.     |
+| onContentError       | `{ error, editor }`       | Called when there's an error with document content.     |
 | onReady              | -                         | Called when the document is fully initialized and ready.|
 | onAwarenessUpdate    | `{ users }`               | Called when user presence information changes.          |
 | onPdfDocumentReady   | -                         | Called when the PDF version of the document is ready.   |
@@ -151,8 +152,8 @@ const editor = new SuperEditor({
 | :---------------------- | :--------- | :------------------------------------- | :------------- |
 | `user`                  | `object`   | Current user information               | {}             |
 | `colors`                | `object`   | Theme color configuration              | Default colors |
-| `role`                  | `string`   | User role: 'editor', 'viewer', 'admin' | 'editor'       |
-| `documentMode`          | `string`   | 'viewing' or 'editing'                 | 'viewing'      |
+| `role`                  | `string`   | User role: 'editor', 'suggester', 'viewer' | 'editor'       |
+| `documentMode`          | `string`   | 'editing', 'viewing', or 'suggesting'  | 'viewing'      |
 | `pagination`            | `boolean`  | Enable pagination                      | true           |
 | `rulers`                | `array`    | Document ruler configuration           | []             |
 | `ydoc`                  | `Y.Doc`    | Yjs document for collaboration         | null           |

docs/src/index.md

@@ -87,15 +87,21 @@ const config = {
   // Required: A DOM element ID to render superdoc into
   selector: '#superdoc',
 
-  // Optional: Initial document mode: viewing, editing. Defaults to viewing
+  // Optional: Initial document mode: viewing, suggesting,editing. Defaults to editing
   documentMode: 'editing',
 
+  // Optional: User role: editor, suggester, viewer. Defaults to editor
+  role: 'editor',
+
   // Required: Documents list with one document
   documents: [
     {
       id: 'my-doc-id', // Required: This document's ID. This is also used as the room name in collaboration.
       type: 'docx', // Required: 'pdf', 'docx' or 'html'
-      data: fileObject, // Optional: A JS File object of your doc, pdf or html file.
+      
+      // Document content - provide EITHER data OR url:
+      data: fileObject, // Option 1: A JS File/Blob object of your document
+      url: 'https://example.com/document.docx', // Option 2: URL to fetch the document from
     },
   ],
 
@@ -144,6 +150,24 @@ const config = {
 };
 ```
 
+## Document Modes and Roles
+
+SuperDoc supports different document modes and user roles to control editing capabilities:
+
+### Document Modes
+
+- **editing** - Full document editing capabilities
+- **viewing** - Read-only mode with no editing allowed
+- **suggesting** - Track changes mode where edits are shown as suggestions
+
+### User Roles
+
+- **editor** - Users with full editing capabilities who can access all document modes
+- **suggester** - Users who can only make suggestions (track changes) but cannot directly edit
+- **viewer** - Users with read-only access who can only view the document
+
+The user's role restricts which document modes they can access. For example, a user with the "viewer" role will always be in viewing mode regardless of the requested document mode.
+
 ## Project Structure
 
 SuperDoc consists of two main packages:
@@ -196,8 +220,9 @@ superdoc.off('ready', myReadyHandler);
 // Export the document as DOCX
 await superdoc.export();
 
-// Switch between viewing and editing modes
+// Switch between viewing, suggesting, and editing modes
 superdoc.setDocumentMode('viewing');
+superdoc.setDocumentMode('suggesting');
 superdoc.setDocumentMode('editing');
 
 // Get a list of HTML strings (one per DOCX editor)