Documentation's Website

[pr-elhajji]

Feature Request

We need to set up a documentation website for OpenTutorAI-CE: https://docs.opentutorai.com/ . The goal is to provide a well-structured, user-friendly, and easily maintainable documentation platform.

Tasks

• Research and confirm the best doc template for documentation.
• Set up a new repository or a /docs folder within OpenTutorAI-CE.
• Configure the site with navigation, search, and API references.
• Add initial documentation (installation guide, usage, API docs).
• Deploy the documentation site (GitHub Pages, Vercel, or Netlify).
• Set up an automated CI/CD workflow for updates.

Expected Outcome

A functional documentation website that helps users and contributors navigate and understand OpenTutorAI-CE.

Additional Notes

• Consider integrating internationalization support for multilingual docs.
• Ensure the documentation site is mobile-friendly.
• Provide markdown-based contribution guidelines.

Important Notes

• Before submitting a report: Please check the Issues or Discussions section to see if a similar issue or feature request has already been posted. It's likely we're already tracking it! If you’re unsure, start a discussion post first. This will help us efficiently focus on improving the project.

• Collaborate respectfully: We value a constructive attitude, so please be mindful of your communication. If negativity is part of your approach, our capacity to engage may be limited. We’re here to help if you’re open to learning and communicating positively. Remember, Open TutorAI is a volunteer-driven project managed by a single maintainer and supported by contributors who also have full-time jobs. We appreciate your time and ask that you respect ours.

• Contributing: If you encounter an issue, we highly encourage you to submit a pull request or fork the project. We actively work to prevent contributor burnout to maintain the quality and continuity of Open TutorAI.

• Bug reproducibility: If a bug cannot be reproduced with a :main or :dev Docker setup, or a pip install with Python 3.11, it may require additional help from the community. In such cases, we will move it to the "issues" Discussions section due to our limited resources. We encourage the community to assist with these issues. Remember, it’s not that the issue doesn’t exist; we need your help!

Note: Please remove the notes above when submitting your post. Thank you for your understanding and support!

---

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[pr-elhajji]

I suggest using TypeDoc and MkDocs for generating documentation for our OpenTutorAI_CE project.

Why These Technologies:
MkDocs with Material theme for general documentation:

Uses Markdown which is accessible to all contributors
Produces a modern, responsive documentation site
Excellent search capabilities out of the box
Simple configuration with YAML
Great for user guides, tutorials, and project overviews
Supports internationalization for multilingual docs
TypeDoc for API documentation:

Specifically designed for TypeScript codebases
Automatically extracts type information from our code
Generates comprehensive API references with minimal manual work
Integrates well with our existing code structure
Implementation Plan:
Create a /docs directory in the main repository with:

A mkdocs.yml configuration file
Markdown files organized by topic in the /docs/src directory
Set up API documentation generation:

Add TypeDoc to our development dependencies
Configure it to output to /docs/api
Document our code with TypeScript and JSDoc comments
Implement CI/CD pipeline:

GitHub Action to build documentation on each merge to main
Deploy to GitHub Pages or Vercel for hosting at docs.opentutorai.com
Add documentation quality checks to our PR process
Create contribution guidelines for documentation to ensure consistency

This approach gives us a balance of user-friendly general documentation and detailed API references while keeping the maintenance burden low through automation.