Skip to content

Commit 8d6feb3

Browse files
authored
Merge pull request #8 from Microck/docs/remove-fake-roadmap-info
Docs: remove non-Windows roadmap/plans
2 parents c3c86d3 + ed11532 commit 8d6feb3

7 files changed

Lines changed: 19 additions & 60 deletions

File tree

docs/architecture/overview.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -453,14 +453,11 @@ Server handles:
453453
- Single-server architecture (no clustering)
454454
- 64MB recovery buffer (bounded memory)
455455
- Windows-only (ConPTY dependency)
456-
- No SSH agent forwarding
457456
458-
### Planned Improvements
457+
### Roadmap
459458
460-
- [ ] SSH config parsing (ProxyJump, LocalForward)
461-
- [ ] Server cleanup on pipe disconnect
462-
- [ ] Cross-platform terminal component (Linux/macOS)
463-
- [ ] AEAD encryption (authenticated encryption)
459+
There is no published roadmap. If you want to propose changes or new features, please open an issue:
460+
https://github.com/Microck/UndyingTerminal/issues
464461
465462
## Next Steps
466463

docs/concepts/encryption.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ The terminal displays the passkey on startup. Save it for client connections.
234234
<Steps>
235235
<Step title="Generate new passkey">
236236
```powershell
237-
# Linux/macOS:
237+
# OpenSSL (any OS):
238238
openssl rand -hex 16
239239
240240
# Windows (PowerShell):

docs/config/server-config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ $hexKey = -join ($bytes | ForEach-Object { $_.ToString("x2") })
131131
Write-Output "shared_key_hex=$hexKey"
132132
```
133133

134-
```bash Linux/MSYS2
134+
```bash OpenSSL (MSYS2/Git Bash)
135135
# Generate random 32-byte hex key
136136
openssl rand -hex 32
137137
```

docs/installation.mdx

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -147,17 +147,12 @@ ConPTY support requires Windows 10 Build 17763 (October 2018 Update) or later.
147147
</Note>
148148
</Tab>
149149

150-
<Tab title="Package Manager (Future)">
150+
<Tab title="Package Manager">
151151
### Package Manager Installation
152152

153153
<Warning>
154-
Not yet available. Track progress on the [GitHub issues page](https://github.com/Microck/UndyingTerminal/issues).
154+
Not available.
155155
</Warning>
156-
157-
Future support planned for:
158-
- Chocolatey: `choco install undying-terminal`
159-
- Scoop: `scoop install undying-terminal`
160-
- WinGet: `winget install UndyingTerminal`
161156
</Tab>
162157
</Tabs>
163158

docs/introduction.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,11 +130,9 @@ Undying Terminal consists of three components:
130130
|----------|--------|-------|
131131
| Windows 10+ | Fully Supported | Primary target platform |
132132
| Windows Server 2019+ | Fully Supported | Service mode available |
133-
| Linux | Planned | Server/terminal components |
134-
| macOS | Planned | Future support |
135133

136134
<Note>
137-
Currently Windows-only, but architecture is designed for cross-platform expansion.
135+
Undying Terminal is Windows-only.
138136
</Note>
139137

140138
## Performance Characteristics

docs/troubleshooting/common-issues.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ Test-NetConnection <HOST> -Port 2022
226226

227227
**If large** (>10MB):
228228
- Wait for catchup to complete
229-
- Future: Reduce keepalive frequency (recompile needed)
229+
- To reduce keepalive frequency: requires a recompile
230230
</Step>
231231

232232
<Step title="Check Server Load">

docs/troubleshooting/faq.mdx

Lines changed: 10 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -48,24 +48,15 @@ Unlike traditional SSH, it implements:
4848
- Optional encryption (XSalsa20)
4949

5050
**Known Limitations**:
51-
- Windows-only (Linux/macOS planned)
52-
53-
See [Roadmap](#roadmap) for planned features.
51+
- Windows-only
5452

5553
### Can I use this on Linux or macOS?
5654

57-
**Not yet**. Currently Windows-only due to ConPTY dependency.
58-
59-
**Planned**:
60-
- Linux: Server + terminal components (TBD)
61-
- macOS: Server + terminal components (TBD)
55+
No. Undying Terminal binaries are Windows executables.
6256

63-
**Current Workaround**:
64-
- Run server on Windows
65-
- Connect from Linux/macOS using SSH bootstrap:
66-
```bash
67-
ssh user@windows-server "cd /path && ./undying-terminal-terminal.exe"
68-
```
57+
If you need to use it from a non-Windows machine, the practical options are:
58+
- Use RDP/Remote Desktop into a Windows machine and run the client there
59+
- Run a Windows VM and run the client there
6960

7061
### What does "undying" mean?
7162

@@ -485,7 +476,7 @@ constexpr auto kKeepaliveInterval = std::chrono::seconds(5);
485476
// Change to desired interval
486477
```
487478

488-
**Future**: Config file option planned.
479+
There is no config file option for this currently.
489480

490481
### How does the recovery buffer work?
491482

@@ -504,34 +495,12 @@ Each connection maintains:
504495

505496
### Can I run the client on Linux?
506497

507-
**Via SSH bootstrap**: Yes
508-
509-
```bash
510-
# Linux client connecting to Windows server
511-
ssh user@windows-server "cd /path && ./undying-terminal-terminal.exe"
512-
```
513-
514-
**Native Linux client**: Not yet (planned)
498+
No. The client is Windows-only.
515499

516500
## Roadmap
517501

518-
### What's planned for future releases?
519-
520-
**v1.0.1 (Released)**:
521-
- SSH config parsing (`~/.ssh/config` support)
522-
- SSH agent forwarding (`-A`/`--ssh-agent`)
523-
- Server cleanup on pipe disconnect
524-
- ProxyJump and LocalForward from config
525-
526-
**v1.2 (Planned)**:
527-
- Linux server + terminal support
528-
- Compression (optional)
529-
- Configurable keepalive interval
530-
531-
**v2.0 (Planned)**:
532-
- macOS support
533-
- AEAD encryption (authenticated)
534-
- Multi-server clustering
502+
There is no published roadmap. If you want to propose changes or new features, please open an issue:
503+
https://github.com/Microck/UndyingTerminal/issues
535504

536505
**Community requests**: [GitHub Issues](https://github.com/Microck/UndyingTerminal/issues)
537506

@@ -550,7 +519,7 @@ See [Contributing Guide](/development/contributing).
550519

551520
### Where can I get support?
552521

553-
**Documentation**: https://undyingterminal.dev
522+
**Documentation**: https://undyingterminal.mintlify.app/
554523
**GitHub Issues**: https://github.com/Microck/UndyingTerminal/issues
555524

556525
**Before asking**:

0 commit comments

Comments
 (0)