The page layout still reflected the Tauri-era docs, where RDP and VNC were a
table row and terminal.md absorbed whatever did not have a home.
Sidebar:
- Drop sidebar_position from all 46 pages. sidebars.ts enumerates every entry
explicitly, so the values never affected ordering, and four of them collided
(guide had two 2s, three 5s, two 6s, two 8s) while implying an order that did
not match the real one.
- Reorder the guide by workflow: session types, per-protocol configuration,
workspace, terminal, monitoring, files, commands, AI, network, auth,
security, appearance, sync, shortcuts.
New pages:
- guide/rdp.md and guide/vnc.md. RDP and VNC are two of the six session types
and had no page of their own. Both document the real config fields, the
validation ranges, the certificate/security policies, and the error kinds,
and both note the helper-process requirement.
- guide/remote-monitoring.md, extracted from terminal.md, covering all five
panels.
Deduplication:
- terminal.md drops from 345 to 253 lines. Its AI, provider, translation, and
risk-tier sections restated ai-assistant.md and translation.md; they are now
the terminal-specific entry points plus a link. The risk tier table moves to
ai-assistant.md, which owns the setting that gates it.
- session-types.md keeps the comparison table and links out for RDP/VNC detail
instead of carrying a second copy of it.
- The migration format list appeared verbatim in four pages. ssh-connection.md
is now the single source; installation.md, quick-start.md, and faq.md link to
it.
- installation.md drops from 112 to 63 lines: its workspace tour, settings
checklist, and "suggested first run" were quick-start.md again.
Verified with `pnpm --dir docs-site build` (both locales) and by resolving
every cross-page anchor against the generated heading ids, since
onBrokenAnchors is set to ignore.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The docs-site pages were migrated from the Tauri build and patched for GPUI
keywords, which left a set of statements that contradict the current code.
Verified each against the implementation and fixed:
- Process Manager and Docker Manager are on by default, not off
(ui_show_process_manager / ui_show_docker_manager default to true).
- There are five SSH monitoring panels, not four. Ascend NPU monitoring was
undocumented; add it and record every panel's real default and interval.
- The AI risk table misfiled its own examples. Bare chmod/chown are medium and
only -R raises them to high; critical is mkfs/wipefs/dd-to-device/fork
bomb/shutdown/rm -rf /. Also replace the invented "level to behavior" mapping
with the real model: effective risk is max(model, local rules), gated by the
three command execution policies and the smart auto-execute ceiling.
- The Command Palette does not contain application actions. QuickSwitchItem
only carries sessions, pending sessions, and saved connections, and the
"session quick switcher" is that same overlay, not a second feature.
- JetBrains Mono / Noto Sans SC Variable / Inter are default font *names*
resolved from system fonts, not bundled files. Nothing under assets/ or
gpui-component's asset crate embeds a font.
- There are two high-contrast themes (Nya HC, Nya HC White).
- Shortcuts are configurable today via Settings -> Keybindings; regroup the
page to match the six in-app categories, add Shift+Insert, and correct
Ctrl+Shift+P, which opens the bottom quick commands panel.
- setup.md omitted that the RDP/VNC helpers must be built or both protocols
fail with HelperMissing, and called the patched dependencies "vendored" when
they are pinned fork revisions. Document the fork/patch workflow.
- architecture.md was missing nyaterm-remote-desktop and both helper crates,
along with the helper-process isolation boundary they exist for.
- Document Vulkan/X11-or-Wayland as a Linux runtime requirement.
- Add the undocumented settings: minimum contrast (WCAG steps), low latency
mode, zebra stripes, multi-line paste review, OSC 52 clipboard writes,
Option-as-Meta, and the scrollback/keep-alive ranges.
Also fills the English mirror gaps this touched: command risk assessment,
command cards, and provider/model sections were absent from the English
terminal page entirely.
Verified with `pnpm --dir docs-site build` (both locales) and by checking the
generated heading anchors the new cross-links point at.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
- Updated backend documentation to clarify crate boundaries and session management.
- Revised frontend documentation to enhance clarity on GPUI desktop development and state management.
- Improved contributing guidelines with clearer workflow and commit conventions.
- Enhanced development setup instructions for better clarity on prerequisites and platform-specific dependencies.
- Updated installation and terminal feature documentation for accuracy and completeness.
- Deleted `check-icon-references.sh` script which verified icon references in the UI.
- Removed `icons.manifest` file that served as a vendor manifest for bundled icon assets.
- Eliminated `package-windows.ps1` script used for packaging the Windows application.
- Removed `sync-icons.sh` script responsible for syncing icon assets from upstream sources.
- Replaced references to "sync and backup" with "cloud sync" throughout the documentation for consistency.
- Clarified the functionality of cloud sync, emphasizing its role in cross-device configuration synchronization and encrypted backups.
- Updated various sections to reflect the new terminology, including settings, guides, and security models.
- Enhanced localization strings to align with the updated terminology and functionality descriptions.
This commit replaces all instances of "Dragonfly" with "NyaTerm" in various files, including documentation, configuration, and UI elements. The changes ensure consistency in branding and improve clarity for users transitioning from the previous version. Additionally, updates to the changelog and README reflect the new application name and its features.
This commit enhances the README and various documentation files to reflect the integration of the AI Assistant in Dragonfly. Key updates include descriptions of AI capabilities, usage scenarios, and configuration settings. Additionally, the installation and quick start guides have been updated to highlight AI features, ensuring users are informed about the new functionalities and how to utilize them effectively.
This commit updates the documentation to reflect the new configuration storage method, specifying that application settings are now stored in `~/.dragonfly/dragonfly.redb`. It clarifies that legacy JSON/text files will be imported on first launch and retained as backups. Changes were made across multiple files, including README.md, FAQ, architecture, backend, and security guides, ensuring consistency in the description of configuration management and data persistence.
Add a complete documentation site under docs-site/ using Docusaurus 3,
with Chinese (default) and English translations. Includes user guide
(SSH, SFTP, terminal, quick commands, themes, translation, security,
shortcuts), developer docs (architecture, setup, frontend, backend,
contributing), FAQ, and a custom landing page.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Kang
