Skip to content

Commit d333eea

Browse files
committed
Docs updated
1 parent d8d24cb commit d333eea

6 files changed

Lines changed: 102 additions & 18 deletions

File tree

‎docs-site/.vitepress/config.mts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ export default withMermaid(
8080
{ text: "Toolbar Reference", link: "/editor/markdown-toolbar" },
8181
{ text: "Code Blocks", link: "/editor/code-blocks" },
8282
{ text: "Tables", link: "/editor/tables" },
83-
{ text: "Diagrams", link: "/editor/diagrams" },
83+
{ text: "Diagrams & Wireframes", link: "/editor/diagrams" },
8484
{ text: "Focus Mode & Outline", link: "/editor/focus-mode" },
8585
],
8686
},
@@ -97,6 +97,7 @@ export default withMermaid(
9797
{ text: "Tasks", link: "/workspace/tasks" },
9898
{ text: "Calendar", link: "/workspace/calendar" },
9999
{ text: "Media", link: "/workspace/media" },
100+
{ text: "Audio Recording & STT", link: "/workspace/audio-recording" },
100101
{ text: "Attached Repositories", link: "/workspace/attached-repos" },
101102
{ text: "Embedded Terminal", link: "/workspace/terminal" },
102103
{ text: "Screen Capture & Recording", link: "/workspace/screen-capture" },

‎docs/editor/diagrams.md‎

Lines changed: 55 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ category: Editor
77

88
# Diagrams
99

10-
Notely supports three diagram formats: **Mermaid** for text-based diagrams written in code, **Excalidraw** for freehand whiteboard-style drawing, and **Draw.io** for structured technical schemas and system architectures.
10+
Notely supports four diagram and visual prototyping formats: **Mermaid** for text-based diagrams written in code, **Excalidraw** for freehand whiteboard-style drawing, **Draw.io** for structured technical schemas and system architectures, and **Wireframe Studio** for responsive low- and high-fidelity UI mockup prototyping.
1111

1212
## Mermaid Diagrams
1313

@@ -129,11 +129,59 @@ Drop any existing `.drawio` or `.drawio.xml` file directly into the Markdown Edi
129129

130130
---
131131

132+
## Wireframe Studio
133+
134+
**Wireframe Studio** is Notely's integrated, visual UI prototyping tool powered by GrapesJS. It provides a drag-and-drop studio designed for rapid wireframing of desktop, tablet, and mobile user interfaces directly within your notes.
135+
136+
### Insert a Wireframe
137+
138+
1. Click the **Insert Diagram** icon (`⚡`) on the Markdown toolbar.
139+
2. Select **Wireframe**.
140+
3. A wireframe placeholder markdown tag is inserted:
141+
```markdown
142+
![Wireframe Diagram](media/wireframes/<diagram-id>.png){data-diagram-id="<diagram-id>"}
143+
```
144+
4. In Preview mode, click the placeholder to open **Wireframe Studio**.
145+
146+
### Stencil Library & Components
147+
148+
The left sidebar organizes over 100 UI stencils into searchable categories:
149+
* **Layouts**: Grid layouts, 2-column/3-column splits, cards, split-screens, and dashboard shells.
150+
* **Forms & Inputs**: Text inputs, checkboxes, toggle switches, select dropdowns, search bars, and date pickers.
151+
* **UI Elements**: Buttons, badges, breadcrumbs, tabs, avatars, pagination, tooltips, and progress bars.
152+
* **Headers & Navigation**: Top navigation bars, sidebars, sub-headers, and mobile app bars.
153+
* **Hero & Content Sections**: Hero banners, feature grids, CTA blocks, and pricing cards.
154+
* **Metrics & Feedback**: Metric stat cards, alert banners, toast notifications, modals, and empty state cards.
155+
* **Tables & Lists**: Data tables, striped tables, and interactive list groups.
156+
* **Device Frames**: Browser windows, mobile phone bezels, and tablet mockups.
157+
* **FontAwesome Icons**: Standard icon library elements for UI actions and navigation.
158+
159+
### Viewport Controls & Canvas Tools
160+
161+
* **Responsive Viewports**: Switch instantly between **Desktop (100%)**, **Tablet (768px)**, and **Mobile (375px)** to verify responsive layouts.
162+
* **Zoom & Pan**: Zoom in/out or fit to screen using bottom status bar controls.
163+
* **Undo / Redo**: Quick hotkeys (`Ctrl/Cmd + Z` / `Ctrl/Cmd + Y`) and toolbar actions.
164+
* **Component Outlines & Guides**: Toggle visual wireframe guides to inspect bounding boxes and alignment.
165+
166+
### Inspector: Properties, Structure & Annotations
167+
168+
The right Inspector panel offers three dedicated modes:
169+
1. **Properties**: Adjust typography, sizing, spacing, borders, background colors, and component attributes.
170+
2. **Structure**: Visual DOM layer tree for inspecting parent-child component hierarchies and reordering elements.
171+
3. **Annotations**: Add design notes, rationale, and UX specifications tied directly to selected wireframe blocks.
172+
173+
### Saving & Storage
174+
175+
* Clicking **Save Wireframe** renders a PNG preview to `media/wireframes/<id>.png` and persists the full project structure to `.notes-app/wireframes/<id>.wireframe.json`.
176+
* Wireframes are fully offline, Git-trackable, and cataloged in the **Diagrams & Media Gallery** (`Ctrl/Cmd + Alt + M`) under the **UI Prototypes** category.
177+
178+
---
179+
132180
## Choosing a Diagram Tool
133181

134-
| Feature | Mermaid | Excalidraw | Draw.io |
135-
|---|---|---|---|
136-
| **Best for** | Fast text-based flows, timelines | Casual sketching, wireframes | Engineering schematics, network charts |
137-
| **Editing** | Text syntax | Visual canvas | Visual canvas |
138-
| **Storage** | Plain Markdown text | JSON `.excalidraw` + SVG preview | XML `.drawio` + PNG preview |
139-
| **Offline** | ✓ | ✓ | ✓ |
182+
| Feature | Mermaid | Excalidraw | Draw.io | Wireframe Studio |
183+
|---|---|---|---|---|
184+
| **Best for** | Fast text-based flows, timelines | Casual sketching, whiteboard | Engineering schematics, network charts | UI prototyping, app mockups, layout wireframes |
185+
| **Editing** | Text syntax | Visual canvas | Visual canvas | Drag-and-drop component studio |
186+
| **Storage** | Plain Markdown text | JSON `.excalidraw` + SVG | XML `.drawio` + PNG | JSON `.wireframe.json` + PNG |
187+
| **Offline** | ✓ | ✓ | ✓ | ✓ |

‎docs/feature-reference.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,11 @@ During transfer:
7878
### Diagrams & Media Gallery
7979

8080
Open via **Workspace -> Diagrams & Media Gallery** (`Ctrl/Cmd + Alt + M`) or Command Palette:
81-
- Catalogs all used diagrams (inline Mermaid, Draw.io, Excalidraw), images, videos, audio, and PDF documents in the workspace.
82-
- **Physical Disk Scanner & Orphan Detection**: Scans workspace folders (`media/`, `assets/`, `images/`) to identify files present on disk that have zero note references.
81+
- Catalogs all used diagrams (inline Mermaid, Draw.io, Excalidraw, Wireframe UI prototypes), images, videos, audio, and PDF documents in the workspace.
82+
- **Physical Disk Scanner & Orphan Detection**: Scans workspace folders (`media/`, `assets/`, `images/`, `media/wireframes/`, `media/draw.io/`) to identify files present on disk that have zero note references.
8383
- **Unused Media Filter**: Quickly isolate unreferenced assets with the `⚠️ Unused / Orphans` filter tab.
8484
- **Audio & Media Preview**: Embedded audio players, video thumbnails, and transcript drawer with key points and action items.
85+
- **UI Prototypes & Wireframe Studio**: View, inspect references, and launch Wireframe Studio to edit interactive UI mockups directly.
8586
- Reuses Knowledge Graph layout aesthetics with collapsible category filters, search, and stat indicators.
8687
- Inspect details for any item with high-res/diagram live previews, file paths, and exact note references with line numbers and snippets.
8788
- Direct "Open Note" navigation and "Copy Markdown Link" actions.

‎docs/git/index.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,15 @@ Using Git directly under the hood ensures:
2323
- **Portability**: Your note history is stored in standard Git format, meaning you can open the folder in any Git client (like GitHub Desktop or VS Code) to view the history.
2424
- **Precision**: Fine-grained line-by-line diffs of changes.
2525
- **Safety**: Rollback individual files or entire folders to a previous point in time.
26+
27+
---
28+
29+
## Attached Code Repositories
30+
31+
Beyond version controlling your markdown workspace notes, Notely allows you to attach external local **Git repositories** to link software architecture directly with documentation:
32+
- **Zero Copying**: Keeps external source code in place on disk.
33+
- **AST Parsing**: Automatic code symbol extraction (classes, methods, functions, endpoints, database models) across 8+ languages using Tree-sitter.
34+
- **Knowledge Graph Integration**: Explorable code entity nodes in the [Knowledge Graph](/ai/knowledge-graph).
35+
- **Referenced Notes**: Mention attached repositories with `[[RepoName]]` or `@RepoName` in any note.
36+
37+
See full guide: [Attached Code Repositories](/workspace/attached-repos).

‎docs/top-tasks.md‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,15 @@ Use this page when you want quick, direct steps.
8080
3. Draw and resize the base image as needed.
8181
4. Save diagram.
8282

83+
## 11c. Insert and design a Wireframe UI mockup
84+
85+
1. Click toolbar diagram action (`⚡`).
86+
2. Select **Wireframe**.
87+
3. Switch to Preview and click the placeholder to launch **Wireframe Studio**.
88+
4. Drag components from the left stencil sidebar onto the canvas.
89+
5. Use the Inspector to tweak properties, structure, and annotations.
90+
6. Click **Save Wireframe**.
91+
8392
## 12. View or restore note history
8493

8594
1. Click the **History** button in the note's top-right toolbar or press `Ctrl/Cmd + Shift + H`.
@@ -146,12 +155,13 @@ Use this page when you want quick, direct steps.
146155

147156
Set mode in **Settings -> Screen Capture**.
148157

149-
## 22. Review open and completed tasks across workspace
158+
## 22. Manage tasks in List or Kanban Board view
150159

151-
1. Open Command Palette (`Ctrl/Cmd + K`).
152-
2. Run **Open Tasks Panel** to review pending tasks.
153-
3. Run **Open All Tasks** to review open + completed tasks together.
154-
4. Open source notes directly from task rows.
160+
1. Open Command Palette (`Ctrl/Cmd + K`) and run **Open Tasks Panel**, or click **Tasks** in the left rail.
161+
2. Toggle between **List View** and **Kanban Board** using the view switch button (`Columns` icon).
162+
3. In Kanban view, drag and drop cards between *To Do*, *In Progress*, and *Completed* columns (or switch grouping to Priority).
163+
4. Filter by timeframe (*Today*, *Upcoming*, *Overdue*) or filter by note.
164+
5. Click any card to edit details in the inspector drawer or jump directly to the source note.
155165

156166
## 23. Export workspace as zip
157167

‎docs/workspace/tasks.md‎

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,19 @@ Notely uses a **4-pass alignment algorithm** to maintain task identity across no
7878
When editing any note, the top header displays a live task completion progress indicator (e.g. `2/5 tasks`). Clicking this indicator opens the **Task Summary Popover**, listing all open and completed tasks for that note with direct line-jump buttons.
7979

8080
### Workspace Task Page
81+
8182
Access the full Task Workspace via the left sidebar or Command Palette (`Ctrl + Shift + T`):
82-
- **Filter by Note**: Focus on tasks from the active note or view tasks across all project notes.
83-
- **Status Tabs**: Easily switch between `All`, `Open`, `In Progress`, and `Completed`.
84-
- **Search & Sort**: Filter tasks by title, priority, due date, or assignee.
83+
- **List & Kanban Board Views**: Toggle between high-density **List View** and visual **Kanban Board** (`Columns` toggle button).
84+
- **Interactive Drag-and-Drop**: Drag task cards between Kanban columns to instantly transition task status or priority. Changes immediately sync back to source Markdown notes.
85+
- **Kanban Grouping Modes**:
86+
- **Group by Status**: *To Do*, *In Progress*, *Completed*.
87+
- **Group by Priority**: *High Priority* (red), *Medium Priority* (amber), *Low Priority* (blue), and *No Priority*.
88+
- **Smart Timeframe Filters**: Filter tasks quickly using sidebar presets:
89+
- **Today**: Tasks due on current date.
90+
- **Upcoming**: Scheduled future tasks.
91+
- **Overdue**: Incomplete tasks past their due date.
92+
- **Completed**: Archived done items.
93+
- **All Tasks**: Workspace-wide master list.
94+
- **Filter by Note**: Focus solely on tasks originating from the active note or view tasks across all project notes.
95+
- **Search & Sort**: Filter tasks by title keywords, tags, priority, due date, or assignee.
96+
- **Task Inspector Drawer**: Click any task card to edit descriptions, due dates, reminder times, assignees, and discussion comments in the detail side panel.

0 commit comments

Comments
 (0)