Skip to content

Commit f89a9ca

Browse files
committed
docs(manual)
1 parent 4ec0eae commit f89a9ca

File tree

3 files changed

+26
-36
lines changed

3 files changed

+26
-36
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# teXt.0w.nz
22

3-
**Your browser is the canvas**. Draw, edit, and collaborate on ANSI, ASCII, NFO, and XBIN art in a retro text art editor rebooted for the modern web. Offline-first with auto-save/restore and local storage, plus optional real-time sessions. Crafted for keyboard-centric artists and creators using mouse or touch, _on any device_. Built with modern tools and automated testing for a seamless experience.
3+
**Your browser is the canvas**. Draw, edit, and collaborate on ANSI, ASCII, NFO, and XBIN art in a retro text art editor rebooted for the modern web. Offline-first with auto-save/restore and local storage, plus optional real-time sessions. Crafted for keyboard-centric artists and creators using mouse or touch, _on any device_. Built with modern tools and automated testing for a seamless experience for text artists and developers.
44

55
![preview](https://raw.githubusercontent.com/wiki/xero/text0wnz/img/preview.png)
66

@@ -101,6 +101,7 @@
101101
- [Architecture](docs/architecture.md) - System architecture and design overview
102102
- [PWA Install](docs/install-pwa.md) - Guide to installing the app on multiple platforms
103103
- [Privacy Policy](docs/privacy.md) - Privacy and data handling policy
104+
- [Security Policy](docs/security.md) - Vulnerability reporting & threat modeling
104105

105106
**Development Guides**
106107

@@ -143,7 +144,7 @@
143144
## Key Bindings & Mouse/Touch Controls
144145

145146
> [!NOTE]
146-
> See: [docs/manual.md](docs/manual.md) for more info.
147+
> See: [docs/manual.md](docs/manual.md#key-bindings-summary) for more info.
147148
148149
### Main Shortcuts
149150

@@ -456,7 +457,7 @@ All tests run automatically in [CI/CD](https://github.com/xero/text0wnz/tree/mai
456457
- Port in use: Change server port or stop other process
457458
- SSL fails: Check cert/key files and permissions
458459
- Client can't connect: Check server, proxy, firewall settings
459-
- WebSocket drops: Validate nginx headers, trailing slash in proxy_pass
460+
- WebSocket drops: Validate webserver headers, note trailing slash in proxy_pass
460461
- Session not saving: Check write permissions, save interval
461462
- Permissions: Confirm systemd user access
462463
- Wrong port: Sync client/server configs

docs/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
# teXt0wnz Documentation
22

3+
![preview](https://raw.githubusercontent.com/wiki/xero/text0wnz/img/preview.png)
4+
35
This directory contains comprehensive guides for using, developing, testing, and deploying the **teXt0wnz** editor.
46

57
## Quick Links
68

79
### For Users / Artists
810

9-
- Start here: "[The Manual](manual.md)"
11+
- Start here: **[The Editor Manual](manual.md)**
1012
- [PWA Install](install-pwa.md): Installation guide for multiple platforms
1113
- [Fonts](fonts.md) - Complete font reference and previews
1214

1315
### For Developers
1416

15-
- Start here: [Building and Developing](building-and-developing.md)
17+
- Start here: **[Building and Developing](building-and-developing.md)**
1618
- Testing: [Testing Guide](testing.md)
1719
- Code quality: [Building and Developing - Linting and Formatting](building-and-developing.md#linting-and-formatting)
1820

1921
### For System Administrators
2022

21-
- Start here: [Webserver Configuration](webserver-configuration.md)
23+
- Start here: **[Webserver Configuration](webserver-configuration.md)**
2224
- Collaboration server: [Collaboration Server](collaboration-server.md)
2325
- Containerization: [Docker Containerization](docker.md)
2426
- Monitoring: [Other Tools - Monitoring Tools](other-tools.md#monitoring-tools)
@@ -27,7 +29,7 @@ This directory contains comprehensive guides for using, developing, testing, and
2729

2830
### Application Guides
2931

30-
- **[The Manual](manual.md)** - Visual guide to the Frontend text art editor
32+
- **[Client Editor Manual](manual.md)** - Visual guide to the Frontend text art editor
3133
- Drawing tools and features
3234
- Keyboard shortcuts and mouse controls
3335
- Color management and palettes

docs/manual.md

Lines changed: 16 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,48 @@
1-
# teXt0wnz Manual
1+
# teXt0wnz Editor Manual
22

33
## Table of Contents
44

55
- [Visual Reference](#visual-reference)
66
- [Top Bar](#top-bar)
7-
- [Editor Menus](#editor-menus)
7+
- [Editor Menus](#-editor-menus)
88
- [File Menu](#file-menu)
99
- [Edit Menu](#edit-menu)
1010
- [Sauce Editor](#sauce-editor)
11-
- [Status Display](#status-display)
11+
- [Status Display](#-status-display)
1212
- [Canvas Resolution / Size](#canvas-resolution--size)
1313
- [Color Management](#color-management)
1414
- [Current Colors](#current-colors)
1515
- [Color Palette](#color-palette)
1616
- [Toolbar & Drawing Tools](#toolbar--drawing-tools)
17-
- [Keyboard Mode](#keyboard-mode)
17+
- [Keyboard Mode](#-keyboard-mode)
1818
- [Screen-Aware Navigation](#screen-aware-navigation)
19-
- [Brushes](#brushes)
19+
- [Brushes](#-brushes)
2020
- [Block / Freehand Brush](#block--freehand-brush)
2121
- [Shading Brush](#shading-brush)
2222
- [Character Brush](#character-brush)
2323
- [Colorize/Attribute Brush](#colorizeattribute-brush)
24-
- [Fill Tool](#fill-tool)
25-
- [Shapes](#shapes)
24+
- [Fill Tool](#-fill-tool)
25+
- [Shapes](#-shapes)
2626
- [Line Tool](#line-tool)
2727
- [Square/Circle Tool](#squarecircle-tool)
28-
- [Selection Tool](#selection-tool)
29-
- [Sample Tool](#sample-tool)
30-
- [Mirror Mode](#mirror-mode)
31-
- [History](#history)
32-
- [Fonts](#fonts)
28+
- [Selection Tool](#-selection-tool)
29+
- [Sample Tool](#-sample-tool)
30+
- [Mirror Mode](#-mirror-mode)
31+
- [History](#-history)
32+
- [Fonts](#-fonts)
3333
- [Font Select](#font-select)
3434
- [iCE Colors](#ice-colors)
3535
- [9pt Font](#9pt-font)
3636
- [Font Examples](#font-examples)
37-
- [Viewport Options](#viewport-options)
37+
- [Viewport Options](#-viewport-options)
3838
- [Zoom](#zoom)
39-
- [Light/Dark Mode](#lightdark-mode)
40-
- [Grid Overlay](#grid-overlay)
39+
- [Light/Dark Mode](#-lightdark-mode)
40+
- [Grid Overlay](#-grid-overlay)
4141
- [Collaboration Features](#collaboration-features)
4242
- [Chat Window](#chat-window)
4343
- [Features](#features)
4444
- [Usage](#usage)
4545
- [Key Bindings Summary](#key-bindings-summary)
46-
- [Main Tool Shortcuts](#main-tool-shortcuts)
47-
- [Color & Character](#color--character)
48-
- [File & Canvas](#file--canvas)
49-
- [Navigation (Keyboard Mode)](#navigation-keyboard-mode)
50-
- [Advanced Editing (`alt` + key)](#advanced-editing-alt--key)
51-
- [Selection Operations](#selection-operations)
52-
- [Selection Navigation](#selection-navigation)
53-
- [Function Keys (`F1``F12`)](#function-keys-f1f12)
54-
- [Mouse Controls](#mouse-controls)
5546
- [Tips & Workflow](#tips--workflow)
5647
- [How to draw?](#how-to-draw)
5748

@@ -167,7 +158,7 @@ The color system uses the classic 16-color ANSI palette with optional iCE colors
167158
- iCE colors (extended 16 background colors)
168159
- Custom palettes in XBIN format
169160

170-
> See [xb-format.md](xb-format.md) for information on custom palettes and [architecture.md](architecture.md) for technical color handling details.
161+
> See [xb-format.md](xb-format.md) for information on custom palettes
171162
172163
# Toolbar & Drawing Tools
173164

@@ -603,8 +594,6 @@ The chat window is available when connected to a collaboration server. It provid
603594

604595
> See [collaboration-server.md](collaboration-server.md) for details on setting up and using the collaboration server.
605596
606-
---
607-
608597
# Key Bindings Summary
609598

610599
**Main Tool Shortcuts:**
@@ -707,8 +696,6 @@ The chat window is available when connected to a collaboration server. It provid
707696
- **alt click:** Sample colors (any tool)
708697
- **right click:** Context menu
709698

710-
---
711-
712699
# Tips & Workflow
713700

714701
1. Start with Keyboard Mode for layout and text

0 commit comments

Comments
 (0)