docs(advanced-usage): cross reference config UI

[ReenigneArcher]

Description

This PR adds hyperlinks in the docs to take the user to the location in the UI where the config categories/settings are located.

Todo:

• Add hash watcher event to toggle config UI tab -> https://developer.mozilla.org/en-US/docs/Web/API/Window/hashchange_event ... see feat(ui): add hash handler for configuration ids #2002

Screenshot

Issues Fixed or Closed

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Dependency update (updates to dependencies)
• Documentation update (changes to documentation)
• Repository update (changes to repository files, e.g. .github/...)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

• I want maintainers to keep my branch updated

[ReenigneArcher]

merge after #2002

[cgutman]

I like the idea but what about people that are using non-default ports?

[ReenigneArcher]

I like the idea but what about people that are using non-default ports?

I'm not sure how to handle that really. It also won't work if someone is viewing the docs from a machine other than the one running sunshine.

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

[ReenigneArcher]

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

I'll work on this in a follow up PR.

[ReenigneArcher]

Description

This PR adds hyperlinks in the docs to take the user to the location in the UI where the config categories/settings are located.

Todo:

• Add hash watcher event to toggle config UI tab -> https://developer.mozilla.org/en-US/docs/Web/API/Window/hashchange_event ... see feat(ui): add hash handler for configuration ids #2002

Screenshot

Issues Fixed or Closed

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Dependency update (updates to dependencies)
• Documentation update (changes to documentation)
• Repository update (changes to repository files, e.g. .github/...)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

• I want maintainers to keep my branch updated

[ReenigneArcher]

merge after #2002

[cgutman]

I like the idea but what about people that are using non-default ports?

[ReenigneArcher]

I like the idea but what about people that are using non-default ports?

I'm not sure how to handle that really. It also won't work if someone is viewing the docs from a machine other than the one running sunshine.

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

[ReenigneArcher]

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

I'll work on this in a follow up PR.

[ReenigneArcher]

Description

This PR adds hyperlinks in the docs to take the user to the location in the UI where the config categories/settings are located.

Todo:

• Add hash watcher event to toggle config UI tab -> https://developer.mozilla.org/en-US/docs/Web/API/Window/hashchange_event ... see feat(ui): add hash handler for configuration ids #2002

Screenshot

Issues Fixed or Closed

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Dependency update (updates to dependencies)
• Documentation update (changes to documentation)
• Repository update (changes to repository files, e.g. .github/...)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

• I want maintainers to keep my branch updated

[ReenigneArcher]

merge after #2002

[cgutman]

I like the idea but what about people that are using non-default ports?

[ReenigneArcher]

I like the idea but what about people that are using non-default ports?

I'm not sure how to handle that really. It also won't work if someone is viewing the docs from a machine other than the one running sunshine.

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

[ReenigneArcher]

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

I'll work on this in a follow up PR.

[ReenigneArcher]

Description

This PR adds hyperlinks in the docs to take the user to the location in the UI where the config categories/settings are located.

Todo:

• Add hash watcher event to toggle config UI tab -> https://developer.mozilla.org/en-US/docs/Web/API/Window/hashchange_event ... see feat(ui): add hash handler for configuration ids #2002

Screenshot

Issues Fixed or Closed

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Dependency update (updates to dependencies)
• Documentation update (changes to documentation)
• Repository update (changes to repository files, e.g. .github/...)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

• I want maintainers to keep my branch updated

[ReenigneArcher]

merge after #2002

[cgutman]

I like the idea but what about people that are using non-default ports?

[ReenigneArcher]

I like the idea but what about people that are using non-default ports?

I'm not sure how to handle that really. It also won't work if someone is viewing the docs from a machine other than the one running sunshine.

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

[ReenigneArcher]

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

I'll work on this in a follow up PR.

[ReenigneArcher]

Description

This PR adds hyperlinks in the docs to take the user to the location in the UI where the config categories/settings are located.

Todo:

• Add hash watcher event to toggle config UI tab -> https://developer.mozilla.org/en-US/docs/Web/API/Window/hashchange_event ... see feat(ui): add hash handler for configuration ids #2002

Screenshot

Issues Fixed or Closed

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Dependency update (updates to dependencies)
• Documentation update (changes to documentation)
• Repository update (changes to repository files, e.g. .github/...)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

• I want maintainers to keep my branch updated

[ReenigneArcher]

merge after #2002

[cgutman]

I like the idea but what about people that are using non-default ports?

[ReenigneArcher]

I like the idea but what about people that are using non-default ports?

I'm not sure how to handle that really. It also won't work if someone is viewing the docs from a machine other than the one running sunshine.

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

[ReenigneArcher]

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

I'll work on this in a follow up PR.

[ReenigneArcher]

Description

This PR adds hyperlinks in the docs to take the user to the location in the UI where the config categories/settings are located.

Todo:

• Add hash watcher event to toggle config UI tab -> https://developer.mozilla.org/en-US/docs/Web/API/Window/hashchange_event ... see feat(ui): add hash handler for configuration ids #2002

Screenshot

Issues Fixed or Closed

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Dependency update (updates to dependencies)
• Documentation update (changes to documentation)
• Repository update (changes to repository files, e.g. .github/...)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

• I want maintainers to keep my branch updated

[ReenigneArcher]

merge after #2002

[cgutman]

I like the idea but what about people that are using non-default ports?

[ReenigneArcher]

I like the idea but what about people that are using non-default ports?

I'm not sure how to handle that really. It also won't work if someone is viewing the docs from a machine other than the one running sunshine.

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

[ReenigneArcher]

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

I'll work on this in a follow up PR.

[ReenigneArcher]

Description

This PR adds hyperlinks in the docs to take the user to the location in the UI where the config categories/settings are located.

Todo:

• Add hash watcher event to toggle config UI tab -> https://developer.mozilla.org/en-US/docs/Web/API/Window/hashchange_event ... see feat(ui): add hash handler for configuration ids #2002

Screenshot

Issues Fixed or Closed

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Dependency update (updates to dependencies)
• Documentation update (changes to documentation)
• Repository update (changes to repository files, e.g. .github/...)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

• I want maintainers to keep my branch updated

[ReenigneArcher]

merge after #2002

[cgutman]

I like the idea but what about people that are using non-default ports?

[ReenigneArcher]

I like the idea but what about people that are using non-default ports?

I'm not sure how to handle that really. It also won't work if someone is viewing the docs from a machine other than the one running sunshine.

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

[ReenigneArcher]

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

I'll work on this in a follow up PR.

[ReenigneArcher]

Description

This PR adds hyperlinks in the docs to take the user to the location in the UI where the config categories/settings are located.

Todo:

• Add hash watcher event to toggle config UI tab -> https://developer.mozilla.org/en-US/docs/Web/API/Window/hashchange_event ... see feat(ui): add hash handler for configuration ids #2002

Screenshot

Issues Fixed or Closed

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Dependency update (updates to dependencies)
• Documentation update (changes to documentation)
• Repository update (changes to repository files, e.g. .github/...)

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

• I want maintainers to keep my branch updated

[ReenigneArcher]

merge after #2002

[cgutman]

I like the idea but what about people that are using non-default ports?

[ReenigneArcher]

I like the idea but what about people that are using non-default ports?

I'm not sure how to handle that really. It also won't work if someone is viewing the docs from a machine other than the one running sunshine.

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

[ReenigneArcher]

Maybe, there could be possibly be a field at the top where they can enter the base url, and then a javascript method could overwrite all the urls.

I'll work on this in a follow up PR.