How to Use SGPro Help Docs¶

Welcome to the SGPro help system. SGPro is hard and docs can help...

Finding What You Need¶

There are essentially 2 different ways to find what you're after in the help docs system.

Use the nav bar located left of this doc.
Use the Search functionality located at the top right.

Is the nav bar missing?

When the help site's window gets too small the left nav will automatically disappear and then reappear when it gets larger.

Tip

The SGPro app itself contains many many context specific links to the help system. You can always navigate, in-app, to the area you're looking for and see if you can find a question mark icon.

Help System Themes¶

You can set the help system theme to either dark or light themes by clicking the sun icon in the title bar.

Tip

When you open help docs from within the SGPro app, the help system will follow your chose SGPro theme, but you can still switch themes manually if you'd like.

Accessing SGPro Help Offline¶

If your rig is remote and does not have access to the internet, we've got you covered. Simply go to the Help menu and click Open Help Docs. Local help files are always an exact replica of the docs found at: https://help.sequencegeneratorpro.com/ ⧉.

Reading Help Files¶

We have taken the time to format these help docs in such a way that you are not simply assaulted with a "wall" of text and, instead, can hopefully find whatever bit of help you're looking for quickly. Here are some of the formats we use:

Callout Boxes¶

Notes are formatted like this

They contain information related to the current topic but not essential to it.

General info is formatted like this

It is super boring.

Tips are formatted like this

These callouts hold tips and hints.

Important callouts are formatted like this

These callouts often contain information about feature dependencies that are not obvious at face value or note that a user should take care when interfacing with a specific feature.

Definitions and vocabulary ore formatted like this

SGPro has lots of definitions and vocabulary and these callout can help you skip through or find them (depending on your current need).

Sometimes we ask ourselves questions

And then we answer them like this...

SGPro "step-wise" instructions look like this

These help docs contain many sections oriented toward things like "Step 1: Do this" and "Step 2: Do that". These callouts help do differentiate where one step ends and the next begins. They are also all "collapsible" and can be easily removed from view to prevent long bouts of scrolling.

SGPro settings look like this

SGPro has hundreds and hundreds of settings. When we reference them from the help system, they will look like this. In almost all cases, settings are rendered "collapsed" and you'll need to click the expand icon on the right of the title bar to get details. The example below shows a settings callout in the collapsed state.

An example SGPro "collapsed" setting

You did it!

Examples are formatted like this

Examples are great and often serve to clarify confusing descriptions. At the same time they add bulk and can make docs more difficult to parse. These callouts can help you find or skip right over any relevant examples.

In-line Text Formatting¶

There are a few formatting techniques used "in-line" (to paragraph text):

References to specific UI controls or labels¶

When paragraph text references specific UI elements they will be highlighted like this.

Example

Read the rotating girter split field and then click the Bananas button.

References to constants and proper nouns¶

When paragraph text references constants or proper nouns they will (also) be formatted like this.

Example

Slew to M42 and then enter 10 in the relevant field.

Glossary Terms¶

When in-line text contains mention of a specific term, module, action or help topic, it will often appear with a single orange line underneath. Hovering the mouse will provide a small tooltip with additional information and clicking the term will take to relevant help docs.

Example

Here is a Super Specific Term in some in-line paragraph text. This one doesn't do anything when you click it but real ones will.