Skip to content

Commit ad7e1f5

Browse files
committed
docs(wiki)
1 parent 8a8911e commit ad7e1f5

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

.github/workflows/wiki.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
mv README.md Home.md
5252
# update layout
5353
echo "## ▓▒▒░ © 2018-$(date +"%Y") : [teXt0wnz](https://github.com/xero/text0wnz) ░▒▒▓" > _Footer.md
54-
echo -e "## **teXt0wnz wiki**\n\n<img src=https://raw.githubusercontent.com/xero/text0wnz/main/src/img/manifest/web-app-manifest-192x192.png width=96>\n\n### Users / Artists\n- [Editor Client](editor-client)\n- [Interface](interface)\n- [Key Bindings](editor-client#key-bindings--mouse-controls)\n- [PWA Install](docs/install-pwa)\n- [Font Previews](fonts)\n\n### Developers\n- [Architecture](architecture)\n- [Project Structure](project-structure)\n- [Building & Developing](building-and-developing)\n- [Testing Guide](testing)\n- [Code Quality](building-and-developing#linting-and-formatting)\n- [Environment Variables](environment-variables)\n\n### SysAdmins\n- [Webserver Config](webserver-configuration)\n- [Collaboration Server](collaboration-server)\n- [Containerization](docker)\n- [Monitoring](other-tools#monitoring-tools)\n- [CI/CD Pipeline](cicd)\n\n### Policies\n- [Security Policy](security)\n- [Privacy Policy](privacy)\n- [Code of Conduct](code_of_conduct)\n- [Contributing Guide](contributing)\n\n### Tech Specs\n- [SAUCE Format](sauce-format)\n- [XBin Format](xb-format)\n\n### Supplemental\n- [Project Logos](logos)\n- [Other Tools](other-tools)\n\n# https://teXt.0w.nz" > _Sidebar.md
54+
echo -e "## **teXt0wnz wiki**\n\n<img src=https://raw.githubusercontent.com/xero/text0wnz/main/src/img/manifest/web-app-manifest-192x192.png width=96>\n\n### Users / Artists\n- [Editor Manual](manual)\n- [Key Bindings](manual#key-bindings-summary)\n- [PWA Install](docs/install-pwa)\n- [Font Previews](fonts)\n\n### Developers\n- [Architecture](architecture)\n- [Project Structure](project-structure)\n- [Building & Developing](building-and-developing)\n- [Testing Guide](testing)\n- [Code Quality](building-and-developing#linting-and-formatting)\n- [Environment Variables](environment-variables)\n\n### SysAdmins\n- [Webserver Config](webserver-configuration)\n- [Collaboration Server](collaboration-server)\n- [Containerization](docker)\n- [Monitoring](other-tools#monitoring-tools)\n- [CI/CD Pipeline](cicd)\n\n### Policies\n- [Security Policy](security)\n- [Privacy Policy](privacy)\n- [Code of Conduct](code_of_conduct)\n- [Contributing Guide](contributing)\n\n### Tech Specs\n- [SAUCE Format](sauce-format)\n- [XBin Format](xb-format)\n\n### Supplemental\n- [Project Logos](logos)\n- [Other Tools](other-tools)\n\n# https://teXt.0w.nz" > _Sidebar.md
5555
# fix internal markdown linx (remove .md extension)
5656
find . -name "*.md" -exec perl -pi -e 's/\]\((?!https?:\/\/)([^)]+)\.md([#][^)]+)?\)/](\1\2)/g' {} \;
5757
git add .

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@
6565
- 16-color ANSI, iCE colors, real-time preview, color conflict resolution
6666
- Custom XBIN color palette support and selection
6767
- **Import/export:**
68-
- ANSI, BIN, XBIN, NFO, UTF-8 TXT, PNG
68+
- ANSI, BIN, XBIN, NFO, DIZ, UTF-8 TXT, PNG
6969
- **Canvas operations:**
70-
- Undo/redo, resizing, font selection, and full SAUCE metadata support
70+
- Undo/redo, canvas resizing, font selection, and full SAUCE metadata support
7171
- **Editor options:**
7272
- Canvas zoom, light/dark mode, and grid overlay
7373
- **Auto Save/Restore**
@@ -88,25 +88,25 @@
8888

8989
- `*.ans`: ANSI art
9090
- `*.utf8.ans`: UTF-8 ANSI for terminals
91-
- `*.bin`: DOS-era BIN
92-
- `*.xbin`: Modern XBIN
93-
- `*.nfo`: Scene/release NFO
91+
- `*.bin`: DOS-era binary format
92+
- `*.xb`: Modern XBIN
93+
- `*.nfo`: Scene/release format
9494
- `*.diz`: FILE_ID.DIZ release files
9595
- `*.txt`: ASCII or other plain text
9696
- `*.png`: Image (export support only)
9797

9898
## Project Documentation
9999

100-
- The [docs](docs/) folder of this repo contains the raw markdown documentation files as well as example artwork to view and play around with.
101-
- The [wiki](https://github.com/xero/text0wnz/wiki) renders these files into easier to read webpages. The wiki also hosts the documentation images to keep the repo size more manageable.
100+
- **The [docs](docs/)** folder of this repo contains the raw markdown documentation files as well as example artwork to view and play around with.
101+
- **The [wiki](https://github.com/xero/text0wnz/wiki)** renders these files into easier to read webpages. The wiki also hosts the documentation images to keep the repo size more manageable.
102102

103103
**Application Guides**
104104

105105
- **[Editor Manual](docs/manual.md) - Visual guide to the Frontend application**
106106
- [Key bindings](docs/manual.md#key-bindings-summary) - Hot keys reference guide
107107
- [Collaboration Server](docs/collaboration-server.md) - Backend real-time collaboration server
108108
- [Architecture](docs/architecture.md) - System architecture and design overview
109-
- [PWA Install](docs/install-pwa.md) - Guide to installing the app on multiple platforms
109+
- [PWA Install](docs/install-pwa.md) - Guide to app installing and OS integration for multiple platforms
110110
- [Privacy Policy](docs/privacy.md) - Privacy and data handling policy
111111
- [Security Policy](docs/security.md) - Vulnerability reporting & threat modeling
112112

docs/install-pwa.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,20 @@
1919

2020
## What is a PWA?
2121

22-
Progressive Web Apps (PWAs) are web applications that can be installed on your device and work like native apps...
22+
Progressive Web Apps (PWAs) are web applications that can be installed on your device and work like native applications.
2323

2424
## Features
2525

2626
### Offline Support
2727

28-
Once installed, teXt0wnz works completely offline...
28+
Once installed, teXt0wnz works completely offline.
2929

3030
### File Handling
3131

3232
**Desktop (Chrome/Edge):**
3333

3434
- OS-level "Open With" integration
35-
- Right-click `.ans`, `.xb`, `.bin` files → "Open with teXt0wnz"
35+
- Right-click `.ans`, `.xb`, `.bin`, etc files → "Open with teXt0wnz"
3636

3737
**Android:**
3838

@@ -103,7 +103,7 @@ This document provides step-by-step instructions for installing a Progressive We
103103

104104
**Steps:**
105105

106-
1. Firefox does not natively support PWA installation as a standalone app on desktop.
106+
1. Firefox _does not_ natively support PWA installation as a standalone app on desktop.
107107
2. You can use a third-party extension like [PWAs-For-FireFox](https://addons.mozilla.org/en-US/firefox/addon/pwas-for-firefox/)
108108
3. Alternatively, use Chrome or Edge for PWA installation on desktop.
109109

@@ -206,7 +206,7 @@ This document provides step-by-step instructions for installing a Progressive We
206206

207207
- For Microsoft Edge (desktop/mobile), installation steps are nearly identical to Chrome.
208208
- Some browsers and platforms may not fully support all PWA features or installation flows.
209-
- PWAs must meet browser criteria for installability (manifest, service worker, HTTPS, etc.).
209+
> See: https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Manifest
210210
211211
---
212212

0 commit comments

Comments
 (0)