Skip to content

Update Auth Docs#181

Merged
lbedner merged 1 commit intomainfrom
auth-docs
Sep 21, 2025
Merged

Update Auth Docs#181
lbedner merged 1 commit intomainfrom
auth-docs

Conversation

@lbedner
Copy link
Copy Markdown
Owner

@lbedner lbedner commented Sep 21, 2025

Update auth docs, dump sync functions in service code, other random stuff.

Copilot AI review requested due to automatic review settings September 21, 2025 04:35
@lbedner lbedner linked an issue Sep 21, 2025 that may be closed by this pull request
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR restructures the authentication service documentation from a single file into a comprehensive multi-page section and removes synchronous database operations in favor of async-only patterns. The changes improve documentation organization and align the auth service with async-first architectural principles.

  • Restructures auth docs into dedicated sections (getting started, API reference, service layer, CLI, examples)
  • Removes sync UserService class and consolidates to async-only UserService
  • Updates all documentation examples to require explicit database component specification

Reviewed Changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated no comments.

Show a summary per file
File Description
mkdocs.yml Expands auth documentation navigation from single page to multi-section structure
docs/services/auth/* Creates new dedicated auth documentation sections with comprehensive guides
docs/services/auth.md Removes original single-file auth documentation
docs/services/index.md Updates CLI examples to require explicit database component for auth service
docs/index.md Updates quick start examples to include required database component
docs/components/index.md Updates component examples to show explicit database requirement
docs/cli-reference.md Updates all auth service examples to require explicit database component
app/services/auth/user_service.py Removes sync UserService class, keeps only async UserService
tests/services/test_auth_integration.py.j2 Updates tests to use async UserService instead of separate AsyncUserService
tests/api/test_auth_endpoints.py.j2 Updates API tests to use unified async UserService
app/services/auth/auth_service.py Updates import to use unified UserService class
app/components/backend/api/auth/router.py Updates router to use unified async UserService
app/cli/auth.py.j2 Converts CLI commands to async pattern using asyncio.run()
hooks/post_gen_project.py Adds cleanup of auth CLI file when auth service is not included
Comments suppressed due to low confidence (1)

@lbedner lbedner added documentation Improvements or additions to documentation service auth labels Sep 21, 2025
@lbedner lbedner self-assigned this Sep 21, 2025
@lbedner lbedner merged commit 24ab6da into main Sep 21, 2025
7 checks passed
@lbedner lbedner deleted the auth-docs branch September 21, 2025 04:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auth documentation Improvements or additions to documentation service

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Auth Service Docs Updates

2 participants