46 lines
1.3 KiB
Org Mode
46 lines
1.3 KiB
Org Mode
#+title: MCIAS Documentation
|
|
#+created: <2025-05-09 Fri 13:42>
|
|
|
|
* 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
|
|
|
|
** [[file:overview.org][Overview]]
|
|
- Project overview
|
|
- System architecture
|
|
- Database schema
|
|
- Security considerations
|
|
|
|
** [[file:api.org][API Documentation]]
|
|
- API endpoints
|
|
- Request/response formats
|
|
- Error handling
|
|
- Authentication flow
|
|
|
|
** [[file:installation.org][Installation and Usage Guide]]
|
|
- Prerequisites
|
|
- Installation steps
|
|
- Running the server
|
|
- Configuration options
|
|
- Building from source
|
|
- Development practices
|
|
- API usage examples
|
|
- Troubleshooting
|
|
- Security best practices
|
|
|
|
* Additional Resources
|
|
|
|
- [[https://git.wntrmute.dev/kyle/mcias][Project Repository]]
|
|
- [[file:../schema.sql][Schema File]] - Database schema definition
|
|
|
|
* Contributing to Documentation
|
|
|
|
When contributing to this documentation, please follow these guidelines:
|
|
|
|
1. Use org-mode 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 |