· 2 min read

Mintlify ile Müşteri Dokümantasyonu, Custom Domain ve Github Entegrasyonu Deneyimim

Mintlify Docs Nedir?

Mintlify Docs, modern ve kullanıcı dostu bir dokümantasyon sitesi oluşturmak için kullanılan, geliştirici dostu ve hızlı bir platformdur. Özellikle SaaS ürünleri ve müşteri dokümantasyonu için tercih edilmektedir. Markdown tabanlı yapısı, kolay özelleştirilebilir temaları ve Github ile entegre çalışma imkanı sunar.

Neden Mintlify Docs Kullandım?

  • Hızlı kurulum ve pratik arayüz
  • Modern ve okunabilir tasarım
  • Markdown desteği ile kolay içerik yönetimi
  • Github ile tam entegre CI/CD (Continuous Deployment)
  • Custom domain ve subdomain desteği (ör: docs.domain.com)

Yeni Domain/Subdomain ile Custom Domain Ayarları

Kendi markanıza ait bir subdomain (ör. docs.domain.com) ile dokümantasyonunuzu yayınlamak için Mintlify Docs üzerinde aşağıdaki adımları izleyebilirsiniz:

  1. Mintlify panelinden projenizi oluşturun veya mevcut bir projeyi seçin.
  2. Sol menüden Settings > Custom Domain bölümüne gidin.
  3. Kendi subdomain’inizi (ör. docs.domain.com) ekleyin.
  4. Domain sağlayıcınızdan (ör. Cloudflare, GoDaddy, vs.) DNS ayarlarına gidin ve aşağıdaki gibi bir CNAME kaydı ekleyin:
    • Name: docs
    • Type: CNAME
    • Value: hosting.mintlify.app
  5. Mintlify panelinde domain doğrulamasını tamamlayın. Genellikle birkaç dakika içinde aktif olur.

Github Entegrasyonu ve Otomatik Yayınlama

Mintlify Docs, Github ile tam entegre çalışır. Böylece dokümantasyonunuzu bir Github repository’sinde tutabilir ve her değişiklikte otomatik olarak siteniz güncellenir.

Adımlar:

  1. Mintlify panelinde yeni bir proje oluştururken Github entegrasyonunu seçin.
  2. Dokümantasyonunuzu Markdown dosyaları olarak repo’ya ekleyin.
  3. Her push veya merge işleminde Mintlify otomatik olarak siteyi yeniden yayınlar.
  4. Gelişmiş preview ve rollback özellikleriyle değişiklikleri kolayca yönetebilirsiniz.

Sonuç ve Deneyimlerim

Mintlify Docs ile müşteri dokümantasyonu hazırlamak hem hızlı hem de profesyonel görünüyor. Custom domain desteği sayesinde marka bütünlüğü sağlanıyor. Github entegrasyonu ile içerik yönetimi ve otomatik yayınlama süreci çok pratik. Özellikle yeni bir domain veya subdomain ile ilk kez dokümantasyon yayına alacaklar için Mintlify Docs kesinlikle tavsiye edilir.

Gerçek Hayattan Mintlify Örnekleri

Mintlify ile hazırladığım ve yayına aldığım bazı örnek projeler:

  • doc.leadrun.co: Leadrun platformu için hazırlanan kapsamlı dokümantasyon sitesi. Custom domain ile kendi markasına özel olarak yayına alındı ve tüm içerik Github üzerinden yönetiliyor.
  • faq.bodrumalbatross.com/introduction: Bodrum Albatross için hazırlanan müşteri destek ve bilgi merkezi. Mintlify Docs altyapısı ile hızlıca yayına alındı, subdomain üzerinden erişilebiliyor ve güncellemeler Github ile otomatik olarak siteye yansıyor.
  • deryabartan.com: Kişisel web sitemi de Mintlify Docs ile oluşturdum. Modern arayüz, hızlı yayınlama ve kolay içerik yönetimi sayesinde profesyonel bir portfolyo ve bilgi merkezi ortaya çıktı.

Bu örnekler, Mintlify Docs’un web ortamında gerçek projelerde ne kadar esnek ve güçlü bir çözüm sunduğunu gösteriyor.


Daha fazla bilgi için: https://mintlify.com/docs

Back to Blog

Related Posts

View All Posts »
Windsurf ile Olan Tecrübem

Windsurf ile Olan Tecrübem

Windsurf ile geçirdiğim süreçte edindiğim deneyimleri, öğrendiklerimi ve bu yolculuğun bana kattıklarını paylaşıyorum.