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.

Sign up for GitHub

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

Jump to bottom

manual-xt ch04 style, ch03 tweaks #354

Merged
merged 12 commits into from
Mar 21, 2024
Merged

manual-xt ch04 style, ch03 tweaks #354

merged 12 commits into from
Mar 21, 2024
+299 −306

Conversation

j5v
Copy link
Collaborator

@j5v j5v commented Mar 20, 2024

The first PR of this content was accidentally deleted, so this was re-created from my backups. Apologies for any confusion.

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 (copied 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.
  • "Surge XT is best used..." is passive. Make active.

mkruselj
mkruselj approved these changes Mar 20, 2024
View reviewed changes
Copy link
Collaborator

@mkruselj mkruselj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@j5v j5v linked an issue Mar 20, 2024 that may be closed by this pull request
Apply technical writing style to the Surge XT manual #348
Open
12 tasks
@j5v
First half of 05 drafed
041ceb0 
Detailed notes will go into PR. Summary:
- Changed definitions for **Pitch** > **Absolute** and **Retrigger**. Need review.
- **Scale-Invariant Linear Modulation** detail removed. Find a home for it?
- Added subheadings to **Other sound generation parameters**.
- Reworded scene **Pitch** and **Octave**.
j5v
j5v commented Mar 20, 2024
View reviewed changes
src/content/manual_xt/05-scene-controls.mdx Outdated
Since the theory behind this concept is difficult to illustrate and explain, trying to apply diffent types and hearing the results
is recommended.
**Notes**:
- If you set **Filter Configuration** to **S1**, **S2**, **S3**, or **Wide**, then any output from filter 1 then routes to filter 2, so **Left** or **Center** routes pass through both filters in turn.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Center: Does this re-add the mixer signal to the input of Filter 2?

@mkruselj mkruselj merged commit 3eb59e4 into surge-synthesizer:master Mar 21, 2024
@j5v j5v deleted the 348-manual-xt-Ch04a branch March 22, 2024 22:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mkruselj mkruselj

@VincyZed VincyZed

@mthierman mthierman

@Andreya-Autumn Andreya-Autumn

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Apply technical writing style to the Surge XT manual
2 participants
@j5v @mkruselj