NEXUS — USER MANUAL

Welcome to Nexus, your all-in-one workspace for documents, databases, projects, knowledge, and AI. This manual reflects the current, working product.

Reality note: Some advanced features are not yet active. Where a feature is unavailable, Nexus shows a clear message (the API returns "Not implemented"). These are flagged below as (not yet available).

---

1. Getting Started

Open Nexus in your browser (e.g. http://localhost:5173 in dev, or your deployed URL).
You'll land on the Landing Page. Click Get Started / Log in.
Create an account or sign in (see Login).
After login you arrive at your Workspace.

Demo/test accounts (in a fresh install, seeded automatically):

EmailPasswordRole admin@nexusworkspace.comNexus@Admin2024!admin user@nexusworkspace.comNexus@User2024!user

⚠️ Change or remove seeded accounts before production (see ADMIN_MANUAL.md).

---

Register: email, password, name. The first registered user becomes admin automatically.
Login: email + password. A session token (JWT, valid 30 days) is stored in your browser.
Forgot password: request a reset link. *Email delivery requires SMTP to be configured by your admin; if email is disabled, contact your admin to reset.*
Log out: profile menu → Log out.
SSO / SAML: (not yet available.)

---

3. Workspaces

A workspace is your top-level container for pages, databases, and projects.

Switch/create workspaces from the Sidebar (top-left workspace switcher).
Invite members: workspace menu → Invite (sends an invite; email delivery requires SMTP).
Members & roles: owners/admins manage membership; permissions via PermissionManager.
Spaces & folders: organize content with SpaceManager and FolderSystem.

---

4. Pages & the Block Editor

Pages are built from blocks.

Create a page: Sidebar + or "New page".
Edit: type to add a paragraph; press / for the slash menu (headings, lists, quote, callout, code, toggle, table, image, file, embed, Mermaid diagram, LaTeX math, etc.).
Nest pages: drag a page under another to create subpages.
Rich blocks: Mermaid diagrams (DiagramBlock), LaTeX (MathBlock), embeds (EmbedBlock), file attachments (FileAttachment).
Outline: jump around long docs with the Document Outline.
Links & graph: create [[page links]]; see backlinks (PageLinks) and the Graph View.
Quick Capture: capture a fast note from anywhere (QuickCapture).
Templates: start from the Template Gallery.
Trash: deleted pages go to Trash and can be restored.
Version history: view a page's history via Version History.

---

5. Databases

Structured, spreadsheet-like data with multiple views.

Create a database from the slash menu or New menu.
Views: Table, Board (Kanban), Calendar, Gallery.
Rows: add/edit rows; bulk add via batch import.
Use cases: task lists, CRMs, content calendars, inventories.

---

6. Projects (Project Management)

Plane-style project tracking via Project Manager.

Projects: create projects to group work.
Issues/Tasks: create, assign, set status & priority.
Cycles (sprints) and Milestones: plan iterations and goals.
Kanban board: visualize issues by status (KanbanBoard).

---

7. AI Assistant

Nexus AI is powered by OpenRouter (one provider, many models).

Availability: your admin must set an OpenRouter API key on the server. If it isn't set, AI features show "AI is not configured."
AI Assistant (AIAssistant): chat to brainstorm, summarize, translate, write code, improve writing; insert results into your page.
Multi-Model Chat (MultiModelChat): pick up to 4 models and compare answers side-by-side. The model list is loaded live from OpenRouter.
Prompt Templates (PromptTemplates): reusable prompts with {{variables}}; click Run to execute against AI.
Document analysis (DocumentProcessor): upload a PDF/DOCX/TXT/MD, extract text, then Summarize / Key points / Q&A with AI.
Model Switcher / Knowledge Base / Code Interpreter / Web Search / Image Generation / Voice Notes: present in the UI.
Code execution, web search, image generation, voice transcription/TTS are (not yet available) and will indicate so.

---

8. Files

Upload: attach files to pages (FileAttachment), or drag into the editor.
Document extraction: in Document Processor, upload PDF, DOCX, TXT, MD to extract real text content.
Limits: default max upload size is 50 MB (configurable by admin).
Storage usage: view your usage in settings/dashboard.

---

9. Collaboration

Real-time editing: changes sync live to others on the same page (WebSocket).
Comments & mentions: discuss inline (Comments); @mention teammates.
Sharing: share pages via Share Modal; publish documents publicly via Document Publishing.
Tags: organize with TagManager.

---

10. Settings

Open Settings (sidebar gear):

Profile: name, avatar, preferences.
Appearance: light/dark mode and themes.
Account: export your data (/api/profile/export) or delete your account (type DELETE to confirm; data is anonymized).
Integrations: connect external tools (Integrations). *Connection testing is (not yet available).*

---

11. Desktop App

Nexus ships a desktop client (Electron) for Windows, macOS, and Linux.

Features: native window, system tray, application menu, native file dialogs, auto-update support.
Install: download the installer for your OS (see DESKTOP_BUILD_GUIDE.md for how builds are produced).
First run: the desktop app connects to your Nexus server (local dev or your deployment).

---

12. Troubleshooting (quick)

SymptomTry "AI is not configured"Ask your admin to set OPENROUTER_API_KEY. Can't reset passwordEmail may be disabled; ask admin to enable SMTP or reset manually. Upload rejectedFile may exceed 50 MB or be an unsupported type (only PDF/DOCX/TXT/MD extract text). "Not implemented" messageThat feature (e.g. billing, SSO, web search) is not active yet. Login loops / logged outToken may be expired (30-day) — log in again. Real-time edits not syncingCheck network/WebSocket; refresh the page.

See the full TROUBLESHOOTING.md for more.

*End of User Manual.*