Skip to content

Commit 3d59617

Browse files
committed
Docs updates
1 parent e3b9928 commit 3d59617

8 files changed

Lines changed: 36 additions & 15 deletions

File tree

docs/.vitepress/config.ts

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,6 @@ export default defineConfig({
107107
{ text: "Architecture", link: "/architecture" },
108108
{ text: "WASM Compatibility", link: "/wasm" },
109109
{ text: "QuickJS Migration", link: "/quickjs" },
110-
{
111-
text: "Design Docs",
112-
collapsed: true,
113-
items: [
114-
{ text: "Finder Abstraction", link: "/design/finder-abstraction" },
115-
{ text: "Search Next Occurrence", link: "/design/search-next-occurrence" },
116-
],
117-
},
118110
{
119111
text: "Internal",
120112
collapsed: true,
@@ -184,6 +176,14 @@ export default defineConfig({
184176
{ text: "SSH Remote Editing Design", link: "/internal/ssh-remote-editing-design" },
185177
],
186178
},
179+
{
180+
text: "Design Docs",
181+
collapsed: true,
182+
items: [
183+
{ text: "Finder Abstraction", link: "/internal/finder-abstraction" },
184+
{ text: "Search Next Occurrence", link: "/internal/search-next-occurrence" },
185+
],
186+
},
187187
{
188188
text: "Core/System",
189189
collapsed: true,
@@ -194,7 +194,6 @@ export default defineConfig({
194194
{ text: "TimeSource Design", link: "/internal/timesource-design" },
195195
{ text: "Unicode Width", link: "/internal/unicode-width" },
196196
{ text: "Readme", link: "/internal/README" },
197-
198197
],
199198
},
200199
],

docs/configuration/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Configuration
22

3+
- [Overview](./) - Layered configuration system
4+
- [Keyboard](./keyboard.md) - Keyboard shortcuts and keybinding configuration
5+
6+
---
37

48
Fresh uses layered configuration.
59

docs/features/editing.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,9 @@ Run shell commands on your buffer or selection:
112112

113113
| Shortcut | Action |
114114
|----------|--------|
115+
| `Ctrl+Home` | Move to document start |
116+
| `Ctrl+End` | Move to document end |
115117
| `Ctrl+G` | Go to line number |
116-
| `Ctrl+]` | Go to matching bracket |
117118
| `F8` | Jump to next error/diagnostic |
118119
| `Shift+F8` | Jump to previous error/diagnostic |
119120
| `Alt+←` | Navigate back in history |

docs/features/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55
- [Navigation](./navigation.md) - Go to definition, position history
66
- [File Explorer](./file-explorer.md) - Browse and manage project files
77
- [Search and Replace](./search-replace.md) - Powerful search with regex support
8-
- [LSP Integration](./lsp.md) - Language server support for diagnostics and completion
98
- [Integrated Terminal](./terminal.md) - Run shell commands without leaving the editor
10-
- [Session Persistence](./session-persistence.md) - Detach and reattach to sessions (Experimental)
9+
- [LSP Integration](./lsp.md) - Language server support for diagnostics and completion
1110
- [Themes](./themes.md) - Customizable color themes
1211
- [Encoding](./encoding.md) - Text encoding detection and conversion
12+
- [Remote Editing (SSH)](./ssh.md) - Edit files on remote machines via SSH
13+
- [Session Persistence](./session-persistence.md) - Detach and reattach to sessions (Experimental)
1314
- [Keybinding Editor](./keybinding-editor.md) - Visual keybinding browser and editor

docs/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
Fresh is a terminal text editor. These docs cover core features, configuration, and plugins.
44

55
## Blog
6+
- **[Fresh 0.2](./blog/fresh-0.2/)** — session persistence, keybinding editor, improved line editing, regex capture groups, and more
67
- **[Editing Features](./blog/editing/)** — multi-cursor, search & replace, move lines, block selection, sort, case conversion, and more
78
- **[Productivity Features](./blog/productivity/)** — command palette, split view, file explorer, keybinding editor, terminal, settings UI, and more
9+
- **[Customization & Themes](./blog/themes/)** — color themes, graphical settings editor, and keybinding editor
810

911
## User Guide
1012
- **[Getting Started](./getting-started/)**
@@ -22,6 +24,7 @@ Fresh is a terminal text editor. These docs cover core features, configuration,
2224
- **[Plugin API](./plugins/api/)**
2325
- **[Plugin Development](./plugins/development/)**
2426
- **[Internal Documentation](./internal/README.md)**
25-
- **[Design Documentation](./design/finder-abstraction.md)**
27+
- **[Design: Finder Abstraction](./internal/finder-abstraction.md)**
28+
- **[Design: Search Next Occurrence](./internal/search-next-occurrence.md)**
2629
- **[WASM Compatibility](./wasm.md)**
2730
- **[QuickJS Migration](./quickjs.md)**
File renamed without changes.

docs/plugins/index.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,21 @@ fresh --init language # Create a language pack
8787
```
8888

8989
For detailed guides, see:
90-
- [Plugin Development](./development/)
91-
- [Language Packs](./development/language-packs.md)
90+
- [Plugin Development](./development/) - Getting started with plugin development
91+
- [Language Packs](./development/language-packs.md) - Creating syntax highlighting and LSP support
92+
- [Common Patterns](./development/patterns.md) - Reusable plugin patterns and recipes
93+
- [Utilities Library](./development/utilities.md) - Built-in utility functions for plugins
94+
- [Internationalization](./development/i18n.md) - Adding translations to plugins
95+
96+
### API Reference
97+
98+
- [Core Concepts & Types](./api/) - Buffers, splits, virtual buffers, overlays, modes
99+
- [Status & Logging](./api/status-logging.md) - Status bar and debug logging
100+
- [Buffer Operations](./api/buffer.md) - Reading and modifying buffer content
101+
- [Overlays & Virtual Text](./api/overlays.md) - Visual decorations on buffer text
102+
- [Filesystem & Paths](./api/filesystem.md) - File and directory operations
103+
- [Events & Hooks](./api/events.md) - Subscribing to editor events
104+
- [Virtual Buffers](./api/virtual-buffers.md) - Creating plugin-managed buffers
92105

93106
## Bundles
94107

0 commit comments

Comments
 (0)