diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 0000000..50430b9 --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,44 @@ +name: Deploy Documentation to GitHub Pages + +on: + push: + branches: + - main + paths: + - 'docs/**' + - '.github/workflows/deploy-docs.yml' + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'docs' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..c78e82d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,37 @@ +# AeThex OS Documentation + +Welcome to the AeThex OS documentation portal. This documentation covers various aspects of setting up, configuring, and using the AeThex OS platform. + +## 📚 Documentation Index + +### Authentication & OAuth +- [**OAuth Quick Start Guide**](OAUTH_QUICKSTART.md) - Get OAuth working in 5 minutes with Discord, Roblox, and GitHub +- [**OAuth Setup**](OAUTH_SETUP.md) - Comprehensive OAuth configuration guide +- [**OAuth Implementation**](OAUTH_IMPLEMENTATION.md) - Technical implementation details for OAuth integration +- [**Credentials Rotation**](CREDENTIALS_ROTATION.md) - Best practices for managing and rotating API credentials + +### Platform & UI +- [**Platform UI Guide**](PLATFORM_UI_GUIDE.md) - Platform-adaptive UI for mobile, desktop, and web environments + +### Security & Access +- [**Entitlements Quick Start**](ENTITLEMENTS_QUICKSTART.md) - Guide to setting up user entitlements and permissions + +## 🚀 Getting Started + +If you're new to AeThex OS, we recommend starting with: + +1. Review the OAuth Quick Start Guide to set up authentication +2. Explore the Platform UI Guide to understand the adaptive interface +3. Configure entitlements for proper access control + +## 📖 Additional Resources + +For more information about AeThex OS, please visit the [main repository](https://github.com/AeThex-Corporation/AeThex-OS). + +## 🤝 Contributing + +If you find any issues with the documentation or would like to contribute improvements, please open an issue or pull request in the main repository. + +--- + +*Last updated: 2025-12-28*