Clean up OAuth docs - #1477
Merged
Merged
Conversation
Replaced "orpheus.gg" with "example.com" in the oauth documentation as there is a non-hack club related website on that domain.
Contributor
Greptile SummaryThis PR updates the OAuth documentation primarily to replace the
Confidence Score: 4/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant App as Your App
participant Browser as User Browser
participant HT as Hackatime OAuth
participant API as Hackatime API
App->>Browser: "Redirect to /oauth/authorize?client_id=...&scope=..."
Browser->>HT: GET /oauth/authorize
HT-->>Browser: Show consent screen
Browser->>HT: User approves
HT-->>Browser: "Redirect to redirect_uri?code=AUTH_CODE"
Browser->>App: Callback with code
App->>HT: POST /oauth/token (code + client_secret)
HT-->>App: access_token (Bearer)
App->>API: GET /api/v1/authenticated/me (Authorization: Bearer token)
API-->>App: User profile JSON
Reviews (3): Last reviewed commit: "Merge branch 'main' into main" | Re-trigger Greptile |
skyfallwastaken
enabled auto-merge (squash)
August 13, 2026 14:22
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaced "orpheus.gg" with "sinerider.com" in the oauth documentation as there is a non-hack club related website on that domain.
Summary of the problem
In the oauth documentation (docs/oauth/oauth-apps.md) on line 16 there is an example redirect url. This url has an active website on it and is not affiliated with hackclub. It also may be confused with an official hackclub / hackatime domain. Later on in the documentation, sinerider.com is used and this change would make the link look more like an example that should not be used in real code. Leaving the old url there may also be free advertising for that site / company.
Describe your changes
Changed the url on line 16 from
orpheus.ggtosinerider.com(hi from mahad: also took the opportunity to make the oauth guide a bit nicer)