Commit Graph
23 Commits
Author SHA1 Message Date
Kang 0bfdf0862f docs(release): document GPUI migration and cutover gates 2026-10-26 14:26:14 +08:00
Kang 8e27865206 ci(contributing, docs): enhance contribution guidelines and installation instructions
- Updated the `CONTRIBUTING.md` to include additional test commands for release asset verification and package metadata generation.
- Revised `README.md` and `README.zh-CN.md` to clarify the installation process for Windows portable editions and added details on migrating from Tauri to GPUI.
- Introduced new workflows for publishing to AUR, Gitee, and Homebrew, ensuring streamlined release processes across platforms.
- Added a new `actionlint.yaml` for workflow syntax validation, improving CI/CD reliability.
- Enhanced documentation to reflect changes in artifact versioning and release management, ensuring clarity for contributors and users.
2026-08-31 10:32:18 +08:00
KangandClaude Opus 5 e18cb3902e docs: cut the template phrasing and the authoring notes
The migrated prose leaned on a small set of constructions and repeated them
until they stopped carrying information. Across ~3.7k lines the source had 78
uses of "适合", 63 of "如果你", and 34 contrastive "而不是" clauses, most of
them attached to bullet lists that restated the feature name.

What changed:
- Replaced the "适合场景 / 适合:" tail hanging off nearly every section with
  either a plain sentence or nothing. "适合" is now 0, "如果你" is 0, and the
  18 remaining "而不是" clauses each rule out an assumption a reader would
  actually make (a rejected password is not truncated; a font name is not a
  bundled file; a decoder panic must not exit silently).
- Removed the closing editorial lines that asserted significance without adding
  information ("这也是 NyaTerm 和普通多标签终端差异较大的地方"), and the
  meta-commentary where the docs explained their own conventions.
- Dropped the relative time anchors that were already going stale: "新的 SFTP
  后端", "较新的工作区", "现在可以", "Newer Agent workflows".
- Deleted the "如果你准备录制文档素材" passage, which told the reader how to
  stage screenshots for the docs rather than how to use the recorder.
- Removed seven `:::tip Screenshot suggestion` blocks that shipped only in the
  English pages. They were internal authoring notes and pointed at a
  /img/docs/ tree and scripts/demo-*.sh files that do not exist in this repo.
- Dropped "推荐的工作流组合", four permutations of features documented
  elsewhere, and gave the synchronized input group one home instead of the
  three partial copies it had across two pages.
- Rewrote the cloud-sync conflict choices to lead with what is lost, since
  "适合:你确认云端版本才是应该保留的版本" buried the fact that local
  unsynced changes are discarded.

Also closes the remaining English gaps found while doing this: selection and
bulk operations, content-fingerprint upload, two FAQ entries, and two
quick-start steps existed only in Chinese. Chinese and English now carry the
same heading count on every page.

Verified with `pnpm --dir docs-site build` (both locales) and by re-resolving
all 22 cross-page anchors against the generated heading ids.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-22 11:27:47 +08:00
KangandClaude Opus 5 049a5a4329 docs: restructure the guide around the pages the features deserve
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>
2026-08-22 11:27:47 +08:00
KangandClaude Opus 5 46d1104440 docs: correct claims that no longer match the implementation
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>
2026-08-22 11:27:47 +08:00
Kang 46057b2447 docs: enhance documentation and features in NyaTerm
- Updated quick start guide to include new session types: RDP and VNC.
- Added support for trzsz file transfer protocol in file transfer documentation.
- Corrected keyboard shortcuts for clearing the screen and tab navigation.
- Improved security documentation regarding known hosts and credential management.
- Enhanced sync and backup documentation with details on GitHub Gist and cloud storage integration.
- Clarified terminal features and output handling in the terminal guide.
- Expanded introduction to include new session types and migration options.
- Added a new pnpm workspace configuration file for build settings.
- Updated changelog to reflect historical context of project evolution.
2026-08-17 00:20:46 +08:00
Kang e31ec74cf7 docs: restructure backend, frontend, and contributing documentation
- 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.
2026-08-16 21:08:40 +08:00
Kang 2a0e705e0e refactor: Remove icon management scripts and related assets
- 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.
2026-08-16 20:34:06 +08:00
Kang 63ff274888 refactor: migrate to GPUI 2026-07-05 17:26:19 +08:00
Kang 4566950ee4 docs: update changelog and documentation
- Added new entries in CHANGELOG.md for version 1.1.12, detailing enhancements to jump host configuration and cycle prevention.
- Updated README.md and its Chinese counterpart to include new AI Assistant features, such as command generation, error analysis, and multi-step workflows.
- Enhanced documentation for terminal features, file transfer capabilities, and user settings to reflect recent changes and improvements.
- Introduced a new guide for the AI Assistant, detailing its working modes, command cards, and risk control mechanisms.
2026-07-01 12:09:28 +08:00
Kang 8612154fa2 docs: update terminology and content for cloud sync
- 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.
2026-06-21 13:10:01 +08:00
Kang f76833dcf1 fix(docs): update backup file extension from .dgfy to .nya across documentation and codebase 2026-05-31 11:03:26 +08:00
Kang 1eb268e584 docs: update Windows installation instructions to include portable edition 2026-05-26 21:34:30 +08:00
Kang 842653e59e chore: Update repository URLs to point to the new GitHub location
This commit updates all references in the documentation and configuration files to reflect the migration of the repository from the previous host to GitHub. Changes include updates to the package.json, Docusaurus configuration, and various markdown files to ensure users have the correct links for issues, releases, and source code.
2026-05-12 00:23:16 +08:00
Kang f7875d7871 refactor: Update references from Dragonfly to NyaTerm across documentation and codebase
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.
2026-05-05 20:05:53 +08:00
Kang d6bd206b5d docs: Expand documentation to include AI Assistant features and updates
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.
2026-04-30 11:14:11 +08:00
Kang 58bd119729 docs: update Docusaurus configuration for broken anchors 2026-04-27 17:19:56 +08:00
Kang 1d49ee59df docs: update README and guides to include new features such as Windows drag-and-drop support, enhanced file transfer capabilities, and diagnostics settings for improved user experience 2026-04-23 14:40:39 +08:00
Kang 483d65fbca docs: enhance documentation with new features including session import/export, diagnostics, and tray support for improved user experience and clarity 2026-04-22 15:01:51 +08:00
Kang 5cd71587c2 docs: enhance documentation and UI for Sync & Backup features, including detailed guides, settings integration, and improved user experience for cross-device configuration and backup management 2026-04-21 22:12:25 +08:00
Kang 0e501c08ba docs: enhance documentation with updates on terminal features, file transfer capabilities, and security enhancements including translation support and improved session management 2026-04-15 09:26:52 +08:00
Kang 5e1e592d87 docs: update README and user guides to enhance clarity on Dragonfly's features, session types, and terminal capabilities; add new sections for workspace layout, security, and network configurations 2026-04-13 15:05:48 +08:00
KangandClaude Opus 4.6 7de160ed04 docs: add Docusaurus documentation site with bilingual support
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>
2026-03-20 13:09:15 +08:00