🆕 Epic | Template - TinaDocs (Open-source Documentation Starter)

[wicksipedia]

Summary

To enhance maintainability, scalability, and marketing potential, we will extract the existing technical documentation from the main Tina.io repository into a dedicated repository. This repository will serve as both the official Tina.io documentation and a starter template for other companies to use as a product documentation solution. The template will compete with existing solutions like ReadMe and Mintlify.

Goals

• Separate documentation from the main Tina.io repository for improved organization and ease of contribution.
• Create a standalone starter template that can be used by other products for their documentation.
• Ensure the new repo maintains full functionality, including versioning, search, and customization options.
• Market the starter template as a competitor to ReadMe and Mintlify.

Key Features & Requirements

1. Extract Docs into a Separate Repo

• Create a new GitHub repository for TinaDocs. #2835
  - [ ] Create a separate repo for Tina.io content #2839
• 📄🦙 TinaDocs | Set up project in Vercel for TinaDocs. #2846
  - [ ] 📄🦙 TinaDocs | Set up automated deployments for the new documentation site. #2848
• 📄🦙 TinaDocs | Migrate TinaDocs code to new repo #2850
  - [ ] Migrate all existing documentation from the main Tina.io repo to the new content repo. #2841
• Update links and ensure proper routing to maintain existing URL structures. #2845

2. Develop the Starter Template

• Using the Template - Setting up with NPX #2847
• 💸 TinaDocs | Using the template - Getting start with quickstart tina-docs#112
• TinaDocs | User Guide - Add documentation into the TinaDocs repo for using the template #2844
• Include support for markdown-based content management.
• Implement search functionality (e.g., Algolia, Lunr.js).
• Versioning Support - Implement & Document #2843
• Provide a theme that aligns with TinaCMS branding but allows theme & UI customization (e.g. "Tina theme"). #2842
• TinaDocs - Canary Testing with JK tina-docs#110
• TinaDocs - Testing with Caleb #3514

3. Enhance Developer Experience

• Theme & UI - Offer configuration options for branding and styling (e.g. additional themes). #2840
• 💸 TinaDocs - API Documentation #2838
• Template: Docs - Provide example documentation to showcase capabilities #2837
• Create starter - Generating from API definition #2836
• Enable easy hosting options (e.g., Vercel, Netlify, or self-hosted). #2834

4. Marketing & Launch Plan

• tinacms/business-backlog#49
• tinacms/business-backlog#50
• tinacms/business-backlog#51
• tinacms/business-backlog#5