Skip to content

docs: Add FAQ section for common questions#538

Open
meichuanyi wants to merge 1 commit into
jonwiggins:mainfrom
meichuanyi:docs/add-faq-section
Open

docs: Add FAQ section for common questions#538
meichuanyi wants to merge 1 commit into
jonwiggins:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi

Copy link
Copy Markdown

Summary

Add a comprehensive FAQ section to the README covering common questions about Optio:

  • What is Optio? (self-hosted AI engineering platform overview)
  • Key Features (Tasks/Jobs/Persistent Agents/Connections)
  • Installation (Quick Start + Production Helm deployment)
  • Requirements (Kubernetes/Node.js/PostgreSQL/Redis/agent credentials)
  • Tech Stack (Fastify/Next.js/Kubernetes/Helm)
  • License (MIT)
  • Help & Resources (documentation links)

Changes

  • Add ~80 line FAQ section after existing README content
  • Cover 7 key topics with structured tables for readability
  • Include quick start commands and production deployment examples
  • Add tech stack summary and help resource links

Checklist

  • Documentation improvement
  • No code changes
  • Follows existing README structure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant