Skip to content

Conversation

@Nerdtality
Copy link
Contributor

Description

This PR adds services and restructures OIDC Guides to be more consistant

I did have to use AI to help point out issues and improvements and merge new changes as they came in

Cleanup inconsistencies in verbiage and instructions
Clear separation between app configuration and VoidAuth configuration
Added references to release notes and setup discussions where relevant
Every application now has a link to its official documentation where available
Linked to specific OIDC/OAuth setup guides
Got straight to the configuration with clear, concise headers
Removed unnecessary setup prose
"Auth Method" (not "Authentication Method")
"Client Secret" (capitalized consistently)
"Redirect URLs" (standardized plural)
"PostLogout URL" (CamelCase)
Every section uses identical header: "VoidAuth OIDC Client Configuration:"
Every app now follows the same pattern: intro > configuration > VoidAuth section > notes/tips
Fields in consistent order: Client ID > Auth Method > Client Secret > Redirect URLs > PostLogout URL
Consistent placement of external documentation links
All notes properly formatted with markdown alerts
Optional fields always marked with comments
Comments standardized with # prefix
Consistent use of colons for key-value pairs
All environment variables now use quotes and proper bash syntax highlighting

Added services:
Jellyseer
ByteStash
Dockhand

Related Tickets & Documents

N/A

Screenshots

See Markdown Preview

@Nerdtality
Copy link
Contributor Author

Nerdtality commented Jan 7, 2026

There are a lot of changes here and likely needs a sanity check, not sure if it looks better either so feel free to close without merging if needed. If you like it, it may also be beneficial to create a guide/template to help others also stay consistent. I think there are also other edits I would like to suggest but let's see where this goes.

@notquitenothing
Copy link
Collaborator

There are a lot of changes here and likely needs a sanity check, not sure if it looks better either so feel free to close without merging if needed. If you like it, it may also be beneficial to create a guide/template to help others also stay consistent. I think there are also other edits I would like to suggest but let's see where this goes.

I will review and let you know what I think 😊 I am currently making some wording changes that may need to be incorporated even if everything else looks good (consistently using 'OIDC App' when talking about what you create/update in VoidAuth)

@Nerdtality
Copy link
Contributor Author

Conflict resolved

Also,

**VoidAuth OIDC Client Configuration:**
Changed back to
**In VoidAuth OIDC App Page:**
since that was already done previously and I did not catch that

@Nerdtality
Copy link
Contributor Author

Question, would WebP (better version of GIF) be better than PNG/JPEG for screenshots or demonstrations?

@notquitenothing
Copy link
Collaborator

Question, would WebP (better version of GIF) be better than PNG/JPEG for screenshots or demonstrations?

WebP would probably be better, but it doesn't make any sense to convert existing images in my opinion since those original images will be stored in the git repo in commit history anyways. If any images were very large and causing slowdown when loading the docs page that could be an exception.

@Nerdtality
Copy link
Contributor Author

Question, would WebP (better version of GIF) be better than PNG/JPEG for screenshots or demonstrations?

WebP would probably be better, but it doesn't make any sense to convert existing images in my opinion since those original images will be stored in the git repo in commit history anyways. If any images were very large and causing slowdown when loading the docs page that could be an exception.

I was thinking more of the lines of me going thru all of these and making step>step>step animations on the most difficult ones. But rethinking through this, it would cause more work for others in the future.

@notquitenothing
Copy link
Collaborator

After review the changes look great, and I will merge the PR soon

@notquitenothing notquitenothing merged commit cff4f6f into voidauth:main Jan 8, 2026
4 checks passed
@Nerdtality
Copy link
Contributor Author

Really quick question, on some of the Environment Variables, was it intentional to have ```bash instead of ```YAML ?

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