SZUT/casino
SZUT/casino
Archived
3
1
Fork 0
Code Issues Pull requests 2 Releases 162 Packages 2 Wiki Activity Actions

docs: Add Auth Docs #307

Merged
csimonis merged 2 commits from docs/auth into main 2025-06-11 12:02:25 +00:00
Conversation 5 Commits 2 Files changed 6 +13 -1
csimonis commented 2025-06-11 11:51:34 +00:00
Owner
Copy link
No description provided.
csimonis added 1 commit 2025-06-11 11:51:34 +00:00
docs: Add API and JWT acronyms to documentation
All checks were successful
CI / Get Changed Files (pull_request) Successful in 9s
Details
CI / Backend Tests (pull_request) Has been skipped
Details
CI / Checkstyle Main (pull_request) Has been skipped
Details
CI / Docker frontend validation (pull_request) Has been skipped
Details
Pull Request Labeler / labeler (pull_request_target) Successful in 10s
Details
CI / eslint (pull_request) Has been skipped
Details
CI / oxlint (pull_request) Has been skipped
Details
CI / Docker backend validation (pull_request) Has been skipped
Details
CI / prettier (pull_request) Has been skipped
Details
Label PRs based on size / Check PR size (pull_request) Successful in 14s
Details
CI / Playwright (pull_request) Has been skipped
Details
CI / test-build (pull_request) Has been skipped
Details
Claude PR Review / claude-code (pull_request) Successful in 1m41s
Details
51d21bc3ee
forgejo-actions added the
size
small
 label 2025-06-11 11:51:53 +00:00
ptran approved these changes 2025-06-11 11:52:34 +00:00
Dismissed
Claude commented 2025-06-11 11:53:09 +00:00
Collaborator
Copy link

Code Review Feedback

I've reviewed the authentication documentation changes. The content is well-structured and comprehensive, but there are several issues that need to be addressed:

Issues to fix:

  1. projektdokumentation/Inhalt/Auth.tex:3 - Typo: "Erfolgreicher" should be "erfolgreicher" (lowercase)

  2. projektdokumentation/Inhalt/Auth.tex:4 - Grammar error: "zwei verschiedene Wege ab" should be "drei verschiedene Wege ab" since you describe three authentication methods, not two

  3. projektdokumentation/Inhalt/Auth.tex:6 - Typo: "validitert" should be "validiert"

  4. projektdokumentation/Inhalt/Auth.tex:8 - Technical inaccuracy: The description suggests the API gets a JWT from the OAuth provider, but OAuth providers typically return access tokens, not necessarily JWTs. Consider clarifying this distinction.

  5. projektdokumentation/Abkuerzungen.tex:35 - There's already a commented API definition on line 16. Consider removing the comment or placing the new definition in a more logical order.

  6. projektdokumentation/Inhalt.tex:3 - Missing newline at end of file

Positive aspects:

  • Good documentation structure with clear section labeling
  • Comprehensive coverage of authentication methods
  • Proper use of LaTeX acronym system

Please address these issues before merging.

## Code Review Feedback I've reviewed the authentication documentation changes. The content is well-structured and comprehensive, but there are several issues that need to be addressed: **Issues to fix:** 1. **projektdokumentation/Inhalt/Auth.tex:3** - Typo: "Erfolgreicher" should be "erfolgreicher" (lowercase) 2. **projektdokumentation/Inhalt/Auth.tex:4** - Grammar error: "zwei verschiedene Wege ab" should be "drei verschiedene Wege ab" since you describe three authentication methods, not two 3. **projektdokumentation/Inhalt/Auth.tex:6** - Typo: "validitert" should be "validiert" 4. **projektdokumentation/Inhalt/Auth.tex:8** - Technical inaccuracy: The description suggests the API gets a JWT from the OAuth provider, but OAuth providers typically return access tokens, not necessarily JWTs. Consider clarifying this distinction. 5. **projektdokumentation/Abkuerzungen.tex:35** - There's already a commented API definition on line 16. Consider removing the comment or placing the new definition in a more logical order. 6. **projektdokumentation/Inhalt.tex:3** - Missing newline at end of file **Positive aspects:** - Good documentation structure with clear section labeling - Comprehensive coverage of authentication methods - Proper use of LaTeX acronym system Please address these issues before merging.
csimonis added 1 commit 2025-06-11 11:53:45 +00:00
add pdf to gitignore
All checks were successful
CI / Get Changed Files (pull_request) Successful in 8s
Details
Pull Request Labeler / labeler (pull_request_target) Successful in 6s
Details
CI / eslint (pull_request) Has been skipped
Details
CI / oxlint (pull_request) Has been skipped
Details
CI / prettier (pull_request) Has been skipped
Details
CI / Backend Tests (pull_request) Has been skipped
Details
Label PRs based on size / Check PR size (pull_request) Successful in 13s
Details
CI / test-build (pull_request) Has been skipped
Details
CI / Checkstyle Main (pull_request) Has been skipped
Details
CI / Docker frontend validation (pull_request) Has been skipped
Details
CI / Docker backend validation (pull_request) Has been skipped
Details
CI / Playwright (pull_request) Has been skipped
Details
Claude PR Review / claude-code (pull_request) Successful in 1m4s
Details
82db59bf51
csimonis dismissed ptran's review 2025-06-11 11:53:45 +00:00
Reason:

New commits pushed, approval review dismissed automatically according to repository settings

Claude commented 2025-06-11 11:54:47 +00:00
Collaborator
Copy link

Code Review Feedback:

Found several issues that should be addressed:

projectdokumentation/Abkuerzungen.tex:16-18: Inconsistent acronym organization - API acronym is commented out then re-added at the end. Please maintain alphabetical order.

projektdokumentation/Deckblatt.tex:27: Missing newline at end of file.

projektdokumentation/Inhalt.tex:3: Missing newline at end of file - this can cause LaTeX compilation issues.

projektdokumentation/Inhalt/Auth.tex:6: Grammar error - 'validitert' should be 'validiert'.

projektdokumentation/Inhalt/Auth.tex:7: Consider using 'Verifizierungs-E-Mail' for consistency.

projektdokumentation/Inhalt/Auth.tex:8: The OAuth explanation is a very long sentence - consider splitting for better readability.

The documentation content is good and well-structured. Please address these formatting and grammar issues.

**Code Review Feedback:** Found several issues that should be addressed: **projectdokumentation/Abkuerzungen.tex:16-18**: Inconsistent acronym organization - API acronym is commented out then re-added at the end. Please maintain alphabetical order. **projektdokumentation/Deckblatt.tex:27**: Missing newline at end of file. **projektdokumentation/Inhalt.tex:3**: Missing newline at end of file - this can cause LaTeX compilation issues. **projektdokumentation/Inhalt/Auth.tex:6**: Grammar error - 'validitert' should be 'validiert'. **projektdokumentation/Inhalt/Auth.tex:7**: Consider using 'Verifizierungs-E-Mail' for consistency. **projektdokumentation/Inhalt/Auth.tex:8**: The OAuth explanation is a very long sentence - consider splitting for better readability. The documentation content is good and well-structured. Please address these formatting and grammar issues.
csimonis force-pushed docs/auth from 82db59bf51 to 187ec1cd7c 2025-06-11 11:55:59 +00:00 Compare
ptran approved these changes 2025-06-11 11:56:34 +00:00
Dismissed
csimonis force-pushed docs/auth from 187ec1cd7c to 4619f787f0 2025-06-11 11:58:22 +00:00 Compare
csimonis dismissed ptran's review 2025-06-11 11:58:22 +00:00
Reason:

New commits pushed, approval review dismissed automatically according to repository settings

ptran approved these changes 2025-06-11 12:00:15 +00:00
csimonis merged commit 6737eb9e4a into main 2025-06-11 12:02:25 +00:00
csimonis deleted branch docs/auth 2025-06-11 12:02:26 +00:00
Commenting is not possible because the repository is archived.
Reviewers
No reviewers
ptran
Labels
Clear labels   
Compat/Breaking

Breaking change that won't be backward compatible

  
Kind/Bug

Something is not working

  
Kind/Documentation

Documentation changes

  
Kind/Enhancement

Improve existing functionality

  
Kind/Feature

New functionality

  
Kind/Security

This is security issue

  
Kind/Testing

Issue or pull request related to testing

  
Priority
Critical
The priority is critical

  
Priority
High
The priority is high

  
Priority
Low
The priority is low

  
Priority
Medium
The priority is medium

  
Reviewed
Confirmed
Issue has been confirmed

  
Reviewed
Duplicate
This issue or pull request already exists

  
Reviewed
Invalid
Invalid issue

  
Reviewed
Won't Fix
This issue won't be fixed

  
Status
Abandoned
Somebody has started to work on this but abandoned work

  
Status
Blocked
Something is blocking this issue or pull request

  
Status
Need More Info
Feedback is required to reproduce issue or to continue work

  
backend

   
ci

   
docs

   
frontend
  
lgtm
blocked

  
lgtm
done

  
lgtm
need 1

  
size
huge

  
size
large

  
size
medium

  
size
small

No labels
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
backend
ci
docs
frontend
lgtm
blocked
lgtm
done
lgtm
need 1
size
huge
size
large
size
medium
size
small
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: SZUT/casino#307
No description provided.
Delete branch "docs/auth"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?