Skip to content

Conversation

@byjg
Copy link
Owner

@byjg byjg commented Nov 6, 2025

Improve documentation

claude and others added 6 commits November 6, 2025 20:33
- Created comprehensive documentation in /docs folder with 12 markdown files
- Added sidebar_position to all docs following the order in README.md
- Fixed inaccurate code examples in README.md to match current implementation
- Updated README with links to all documentation sections
- Fixed example.php to use correct API (UsersAnyDataset constructor, SessionContext)
- Organized docs with proper Docusaurus frontmatter and features
- Added detailed guides for:
  * Getting started and installation
  * User management (CRUD operations)
  * Authentication methods (session and JWT)
  * Session context and storage options
  * User properties (custom key-value data)
  * Database storage and schema customization
  * Password validation and generation
  * JWT token authentication
  * Custom fields and extending UserModel
  * Mappers and entity processors
  * Complete working examples
- Removed duplicate and outdated information from README
- Added feature list and improved organization
- All code examples now reflect actual API usage
Consolidated duplicate content and improved documentation structure:

README.md changes:
- Removed duplicate installation examples
- Simplified Basic Usage to single example
- Removed detailed sections (now in specific docs)
- Replaced with Features section linking to docs
- Simplified Dependencies section

docs/getting-started.md changes:
- Removed duplicate Key Features list
- Simplified Quick Example code

docs/authentication.md changes:
- Added cross-reference to Password Validation

docs/custom-fields.md changes:
- Added clarity on when to use vs Database Storage

Benefits:
- Single source of truth for each concept
- Clear navigation through cross-references
- Better maintainability
- Removed text descriptions from Dependencies section
- Now shows only mermaid flowchart with project dependencies
- Dependencies sourced from composer.json:
  * byjg/authuser --> byjg/micro-orm
  * byjg/authuser --> byjg/cache-engine
  * byjg/authuser --> byjg/jwt-wrapper
- Section remains as last section before footer
Removed dependencies section and related information from installation documentation.
…recate `SessionContext` usage, and clarify differences for security and scalability.
@byjg byjg merged commit 31eb80c into 6.0 Nov 6, 2025
@byjg byjg deleted the claude/6.0-011CUsFnWv7Y75UH4Q9vfcPX branch November 6, 2025 21:31
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.

3 participants