docs: add comprehensive wiki documentation for snap-saas-base
Add a new markdown file `snap-saas-base_wiki.md` to provide detailed
documentation for the `snap-saas-base` project. This includes sections
on introduction, development environment setup, data models, and
development workflow. The documentation aims to guide developers in
setting up and using the project efficiently, ensuring consistency and
standardization across development teams.
docs: add detailed documentation for development environment and data model
Add comprehensive documentation for setting up and using the development
environment, including Docker and VS Code Dev Container configurations.
Explain the purpose and functionality of the SQLAlchemy ORM data model,
detailing the core components and their attributes. This documentation
aims to improve developer onboarding and ensure consistent understanding
of the project's architecture and data handling.
feat(models): add Workspace and Chat models to represent workspaces and chat sessions
Introduce Workspace model to manage workspace-related data, including
name, slug, bucket, and organization ID. Add Chat model to handle chat
sessions within a workspace, with attributes for channel, status, and
state. These models enhance the application's data structure, enabling
better organization and management of workspace and chat data.
docs: add documentation for data models and Pydantic schemas
Provide detailed documentation for the newly added Workspace and Chat
models, including their attributes and relationships. Also, document
Pydantic schemas for data validation and structuring, explaining their
purpose and usage. This documentation aids in understanding the data
model architecture and facilitates easier integration and testing.
docs: add detailed documentation for user schemas and development workflow
Add comprehensive documentation for `UserBaseSchema` and related
schemas, including usage examples and architectural fit. Introduce
a development workflow section detailing key files, tools, and
testing strategies. Include diagrams to illustrate schema
relationships and workflow processes. This enhances understanding
and provides clear guidance for contributors, ensuring consistency
and efficiency in development practices.
docs(tests): add detailed documentation for test cases and CI setup
Include explanations and code examples for test cases related to
models and schemas. Provide setup and usage instructions for running
tests. Document the GitHub Actions workflow for continuous integration
and illustrate component relationships with a diagram.
02a253e