Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Surge XT manual - 04 style update, 03 tweaks #353

Closed
wants to merge 2 commits into from

Conversation

j5v
Copy link
Collaborator

@j5v j5v commented Mar 19, 2024

Notes on style update for Surge XT manual, chapter 04

Style notes

  • For consistency with the UI, we should stay with "enable"/"disable". Ideally, we'd change both docs and UI to use inclusive language "activate"/"deactivate".

Decisions

  • I've added a warning to Global Hard Clip... options. We should remove it if this could get us into legal trouble for steps that might still be unsafe.

    Warning: Change Global Hard Clip with care. Loud sounds increase the risk of damaging equipment or hearing. You should also limit sounds in your DAW or downstream equipment. Take special care with feedback, effects, and resonance features.

  • Text "Main Menu" doesn't appear in the UI, so we should call it "the main menu". "Menu" does, but "Menu" is ambiguous.

Docs todos (moved into #348)

  • Patch browser screenshot needs update, to show the Undo UI.
  • Save dialog screenshot needs update, to show "Store tuning in patch"
  • Cross-reference MPE things (Dual/split, Status button, main menu).
  • Some cross-references (in Polyphony limit) should jump more precisely to related content. Use custom anchors, or create lower-level headings.
  • Make "Surge XT is best used..." active.

Scope limited to manual-xt only, with some tighter spacing on the page.astro template.
@j5v j5v closed this Mar 19, 2024
@j5v j5v deleted the 348-style-refresh-ch04 branch March 19, 2024 23:33
@j5v j5v linked an issue Mar 20, 2024 that may be closed by this pull request
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Apply technical writing style to the Surge XT manual
1 participant