docs: enhance documentation for document modes and user roles; clarify functionality in method descriptions

Author: caiopizzol

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)          |

docs/src/index.md

@@ -87,7 +87,7 @@ 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
@@ -220,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)