Skip to content

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Jan 7, 2024

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:

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 ReenigneArcher force-pushed the docs(advanced-usage)-cross-reference-config-UI branch 5 times, most recently from dd40f7c to 82b7abd Compare January 8, 2024 01:34
@ReenigneArcher
Copy link
Member Author

merge after #2002

@cgutman
Copy link
Collaborator

cgutman commented Jan 13, 2024

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

@ReenigneArcher
Copy link
Member Author

ReenigneArcher commented Jan 13, 2024

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
Copy link
Member Author

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 ReenigneArcher marked this pull request as ready for review January 13, 2024 04:32
@ReenigneArcher ReenigneArcher force-pushed the docs(advanced-usage)-cross-reference-config-UI branch from 82b7abd to 71d1dfb Compare January 14, 2024 04:46
@ReenigneArcher ReenigneArcher merged commit ec1ae4a into nightly Jan 14, 2024
@ReenigneArcher ReenigneArcher deleted the docs(advanced-usage)-cross-reference-config-UI branch January 14, 2024 13:16
KuleRucket pushed a commit to KuleRucket/Sunshine that referenced this pull request Jun 6, 2024
e-dong pushed a commit to e-dong/Sunshine that referenced this pull request Jul 26, 2024
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.

2 participants