Table of contents is aimed at power users

[tbreuss]

The tables of contents are mainly aimed at power users, see screenshot. Without knowing the abbreviations, it is of little to no help. For example, if you are a new user and are searching for a function on this page and do not know the abbreviations.

Instead of abbreviations, it would be more helpful to display the function behind them, or alternatively both.

Before:

• nh
• ah
• v
• h
• t

After, variant 1:

• nh (natural harmonic)
• ah (artificial harmonic)
• v (vibrato)
• h (hammer-on/pull-off)
• t (tied note)

After, variant 2:

• natural harmonic
• artificial harmonic
• vibrato
• hammer-on/pull-off
• tied note

[tbreuss]

@Danielku15 If you agree, I could suggest a code change here and submit a pull request. If you have a specific idea for this change, you could provide a concrete example.

[Danielku15]

Any contributions to improve the docs are welcome. Some guidance on these pages:

The alphaTex documentation is auto-generated via this script: https://github.com/CoderLine/alphaTabWebsite/blob/develop/scripts/generate-alphatex.mts

It uses the language definitions from here: https://github.com/CoderLine/alphaTab/tree/develop/packages/alphatex/src

[tbreuss]

Before I go too far here, I would first like to get some feedback.

I would do it this way:

• Headings in title case (capitalizing major words)
• Remove the abbreviation completely from the heading because
  • we have it in the syntax description (see first arrow)
  • and in the examples (see second arrow)

I would do this changes first for:

• Beat Properties
• Note Properties

What do you think?

[tbreuss]

After a new installation, I get many of these errors in the develop branch.

How can I prevent them?

[Danielku15]

Headings in title case (capitalizing major words)

I don't have a strong opinion on capitalization. Just generally we should use the shortDescription from here as-is: https://github.com/CoderLine/alphaTab/blob/e375391f8134c08dfc05cc1d1e9454d975bc939d/packages/alphatex/src/properties/note/ah.ts#L34

Its the same what we show in the UI of code editors. But feel free to adjust the strings in the central definition to improve the look&feel.

Remove the abbreviation completely from the heading because we have it in the syntax description (see first arrow) and in the examples (see second arrow)

Let's keep the abbreviations for now. It has significant impact to the search index.

How can I prevent them?

#166
https://github.com/CoderLine/alphaTabWebsite/blob/develop/.github/workflows/deploy-develop.yml#L23