43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
# MCIAS Documentation
|
|
|
|
Welcome to the MCIAS (Metacircular Identity and Access System) documentation. This directory contains comprehensive documentation for understanding, installing, and using the MCIAS system.
|
|
|
|
## Documentation Index
|
|
|
|
### [Overview](overview.md)
|
|
- Project overview
|
|
- System architecture
|
|
- Database schema
|
|
- Security considerations
|
|
|
|
### [API Documentation](api.md)
|
|
- API endpoints
|
|
- Request/response formats
|
|
- Error handling
|
|
- Authentication flow
|
|
|
|
### [Installation and Usage Guide](installation.md)
|
|
- Prerequisites
|
|
- Installation steps
|
|
- Running the server
|
|
- Configuration options
|
|
- Building from source
|
|
- Development practices
|
|
- API usage examples
|
|
- Troubleshooting
|
|
- Security best practices
|
|
|
|
## Additional Resources
|
|
|
|
- [Project Repository](https://git.wntrmute.dev/kyle/mcias)
|
|
- [Schema File](../schema.sql) - Database schema definition
|
|
|
|
## Contributing to Documentation
|
|
|
|
When contributing to this documentation, please follow these guidelines:
|
|
|
|
1. Use Markdown format for all documentation files
|
|
2. Keep the documentation up-to-date with code changes
|
|
3. Include examples where appropriate
|
|
4. Organize content logically with clear headings
|
|
5. Use code blocks with syntax highlighting for code examples |