Docs: accuracy and clarity sweep

オープン
#86 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
50/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
json, markdown, powershell, python
領域
documentation

調査の方向性

Start by reading getting-started.md, hotkeys.md, troubleshooting.md, studio.md, menus.md, bridge.md, SECURITY.md, and the smaller documentation files, then use the audit IDs to track each requested correction. Check the documented behavior against the Python implementation and referenced logs, and verify the ZBrush 2026 gesture details before editing. The work is complete when all listed audit points are addressed or explicitly deferred, headings and links are corrected, and the updated documentation is rebuilt and reviewed.

索引モデルが issue の本文から書いたものです。

説明

documentation

From the audit of ZOrbit 0.11.0 (31 October 2026). Accuracy and clarity points not covered by the install and update issues. Line references may move; find the quoted text.

getting-started.md

  • First steps say "On the Menus screen", but a fresh install opens Studio on Setup; the page never mentions Setup.
  • Nothing tells a ZBrush user what ZOrbit takes over: Q is ZBrush's Draw-mode key and a menu hotkey is swallowed everywhere in ZBrush while the menu uses it (dialogs and text fields included); Alt+B; F9 in 2022 to 2025; and how to change each. The only warning is the last bullet of hotkeys.md.
  • The tray icon may be in the notification overflow; the browser is not mentioned; nothing is said about pen tablets (keys sent by a tablet driver are ignored as injected input).

hotkeys.md

  • "With flicking on, moving out of the ring always picks something" is not true for one to three slots (each slot covers at most a quarter of the circle). "Duplicates are reported as problems and ignored" does not say which menu keeps the key (the first one in the file).
  • Document the tap rule and the moved-in ring rule once the daemon issue lands.

troubleshooting.md

  • No entry for Studio not opening, opening blank, or doing nothing on a second click (WebView2 runtime, studio.log, a stuck first instance). The runtime has no fix or link anywhere.
  • No entry for the commonest first-run puzzle: the pick logs "selected" and nothing changes because no tool is in Edit mode (bridge.log ends in "(Edit mode is off)"). Other bridge.log results a user will read ("selecting it once ZBrush has added it", "its button did not appear within a second") are not explained either.
  • "A slot shows letters instead of a picture: for a brush, that means no .zbp was found" is wrong for the stock brushes in the docs' own screenshots (see the thumbnails issue); say a letter tile is a missing picture and the pick still works.
  • "An amber dot means a check is failing" overstates it; the listener is named three different ways.
  • files.md:46 and the issue template say logs hold "brush names and menu ids"; they also hold the Windows user name and folder paths (the bridge logs where it loaded from and what it started; the app logs the popout command line; studio.log the working directory). Say so, or replace the profile prefix with %USERPROFILE% in the log helpers.

studio.md

  • The whole page after the tray section sits under the one H2 "The tray icon", so Setup, saving, the Menus screen and the tabs have no anchor and do not show in the contents. Add headings.
  • The Status row omits the Last pick card, the log folder buttons and the 3 s refresh; the Swallow switch is described as "off" for a menu without a hotkey but shows on and dimmed.

menus.md

  • SubDivide is described as a submenu of Brushes; it is in Tools.
  • Press, Set and Toggle never say how to find a button's path in ZBrush or what value means (the slider's shown value, its range). Add a short "Finding a button's path" with worked examples (verify the exact gesture in ZBrush 2026) and say what a wrong path does (nothing, with a log line).
  • The brush folders searched, subfolder recursion and the skipped _ folders are not documented; icon must be an absolute path; the fan badge is never described (fan.png and fan-out.gif predate it); a Steps item's picks are not counted for auto slots or Recent although the page says every pick counts (fix the text or the code); no single list of a menu's fields and id rules.

bridge.md and SECURITY.md

  • "A keyboard hook watches for your menu hotkeys, but only while ZBrush is the front window" is wrong: the hook is global and compares every key; only the hotkey match checks that ZBrush is in front. Say: "ZOrbit installs a Windows keyboard hook. It compares each key press with your hotkeys and acts only when ZBrush is the front window. It does not record, store or send what you type." Put the same two sentences in README and SECURITY.md.
  • The elevated-helper sentence overclaims (see the design issue on elevation). The 2022 to 2025 differences list omits the code page and 255-byte limits and the F9 caveat. The same key is called fallback key, bridge key and F9.
  • SECURITY.md should say that importing or opening someone else's menus file runs their buttons in ZBrush.

Smaller

  • files.md: the table omits tags.json.bak, the rotated .old logs and zscript_stage. appearance.md: "the browser then opens from Browser slots only" contradicts the list of ways to open it; "the fan of a tag slot is always drawn in that tag's colour" is not true with tint, glow and band off; the reference is keyed by radial.json names while Studio shows labels. tags.md: the example omits the favourite tag every real file has; the rename clash offers "keep them apart", which the page says cannot happen. browser.md: nothing says the filters reset when a closed browser comes back, or that opening a hidden browser starts it afresh; the command-line start gives the flags but not the command. building.md omits the PowerShell execution policy and Inno Setup. CLAUDE.md's code-to-page table misses some files. The mkdocs nav puts Troubleshooting under "Under the hood" although index.md says to start there. The Studio screenshots show v0.10.2; retake them.

Audit ids: F067, F295, F085, F100, F102, F134, F143, F167, F187, F299, F211, F163, F218, F038, F233, F140, F121, F115, F086, F139, F118, F075, F076, F277, F145, F353, F096, F074, F023, F222, F291, F226, F292, F223, F146, F158, F033, F095, F320, F258, F250, F293, F061, F026, F261, F154, F185, F137, F060, F064, F296, F248, F267, F107, F351, F141, F249, F313, F294, F321, F251, F192, F229, F245, F268, F270.

主要言語
Python
スター
2
フォーク
1
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

combwizard/ZOrbit のほかの issue

combwizard/ZOrbit の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。