DevDocs: Birden fazla teknoloji dokümanında tek yerden arama yapan dokümantasyon platformu

 (devdocs.io)
3 puan yazan GN⁺ 2024-01-14 | 1 yorum | WhatsApp'ta paylaş
  • Geliştiricilerin sık başvurduğu API dokümanlarını tek yerde toplayıp hızlı arama olanağı sunarak, dil ve framework dokümanları arasında geçiş maliyetini azaltır
  • Varsayılan olarak CSS, HTML, HTTP, JavaScript ve Web APIs gösterilir; Preferences bölümünden ihtiyaç duyulan dokümanlar etkinleştirilebilir ve ekran ayarlanabilir
  • bgcp ile background-clip bulmayı sağlayan fuzzy matching ve dokümana göre arama kapsamı belirleme sayesinde istenen öğelere daha hızlı erişilebilir
  • Fare kullanmadan çalışmaya uygun klavye kısayollarını, tarayıcı adres çubuğu aramasını, mobil kullanımı ve web app olarak kurulumu destekler
  • Dokümanlar çevrimdışıyken de görüntülenebilir; ücretsiz ve açık kaynaklı bir proje olduğu için geliştirme ortamına göre rahatça kullanılabilir

Birden fazla API dokümanında tek yerden arama

  • DevDocs, birden fazla API dokümanını hızlı ve düzenli tek bir arama arayüzünde birleştirir
  • Varsayılan ekranda CSS, HTML, HTTP, JavaScript ve Web APIs dokümanları gösterilir
  • Preferences bölümünden daha fazla doküman etkinleştirilebilir ve UI özelleştirmesi yapılabilir

Arama ve gezinme yöntemi

  • Arama fuzzy matching desteği sunar
    • Örneğin bgcp girildiğinde background-clip bulunabilir
  • Yalnızca belirli bir dokümanın içinde arama yapmak istediğinizde, doküman adını veya kısaltmasını girip Tab ile arama kapsamını daraltabilirsiniz
  • Tarayıcı adres çubuğu araması da kullanılabilir; kurulum yöntemi kılavuzda görülebilir

Klavye odaklı kullanım

  • Fare olmadan da gezinme ve arama yapılabilir
  • Klavye kısayolları listesine bakılabilir veya ? tuşuna basılarak kullanılabilir kısayollar görülebilir

Çevrimdışı kullanım ve kurulum desteği

  • DevDocs çevrimdışı da çalışır
  • Mobilde kullanılabilir ve web app olarak kurulabilir

Ücretsiz açık kaynaklı proje

İlgili okumalar

1 yorum

 
GN⁺ 2024-01-14
Hacker News yorumları

  • Az sayıdaki DevDocs bakımcısından biriyim
    Dokümantasyon sistemi ya da tasarım baştan aşağı değişmediği sürece, yeni sürümlere uygun şekilde dokümanları güncellemek kolay. Ancak react.dev'in yeniden tasarımı gibi bazı projeler bu tür değişiklikleri epey sık yapıyor gibi görünüyor
    Bazı dokümantasyon oluşturucuları, Gatsby'nin docs.npmjs.com'da ürettiği .gtWOdv, .ezMiXD, .gOhcvK gibi rastgele sınıf adları oluşturuyor; bu da sayfa gezinmesi gibi gereksiz içerikleri ayıklama işini zahmetli ve kırılgan hâle getiriyor
    Her ay eski dokümanların listesini otomatik olarak oluşturuyoruz; en güncel liste burada: https://github.com/freeCodeCamp/devdocs/issues/2105
    Yardım her zaman memnuniyetle karşılanır

    • simon04, bakımcıların çok uzun zaman önce yaptığı işler kariyerimde ve sonrasında hayatımda büyük fark yarattı
      Aceleyle üstlendiğim bir yazılım işi üzerinde çalışırken işe gidip gelirken çevrimdışı dokümantasyon okuyabilmek gerçekten çok önemliydi
      devdocs'a yardım ederek hiç para kazanmamış olabilirsiniz, ama gerçek insanlara yardımcı olduğunuzu mutlaka bilmenizi isterim
    • Bu uygulama kişisel olarak epey can sıkıcı. En iyi dokümantasyon kaynaklarından biri ama seçtiğim doküman listesini koruyamadığı için neredeyse kullanılamaz hâle geldi
      Neredeyse her ziyaretimde kullandığım stack'i baştan seçmem gerekiyor. Harika, ama bunu sürekli tekrar edecek kadar harika değil
      Başka yerlerde çerezlerin ya da yerel depolamanın kaybolması gibi bir sorun yaşamıyorum ve güncel Linux Chrome kullanıyorum. Olası sebep hakkında bir tahmininiz var mı?
    • Dokümantasyon oluşturucularını tüketim kolaylığı açısından değerlendirebilir misiniz?
      Sphinx, Docsy, MkDocs, Docbook vb.'nin semantik olarak çıkarım yapma kolaylığı bakımından nasıl karşılaştırıldığını bilmek isterim
    • Bir teknik mülakatta, belirli bir framework ile XYZ'yi nasıl yapacağıma dair bir soru almıştım
      Tam olarak bilmediğimi, ama devdocs.io'da API arayüzüne bakarak daha iyi anlamaya çalışacağımı söyledim
      Mülakatçı ne demek istediğimi anlamadı, bu yüzden dizüstü bilgisayarında doğrudan açtı ve epey şaşırdı
      Elbette o işi alamadım, ama mülakat masasının karşı tarafına bilgi yaymak oldukça güzel bir şeydi
    • Bu sitenin yaşamaya devam etmesi bu tür katkılar sayesinde; bunun sonucunda Python 3.8'den beri sevdiğim güncellemeler hakkında bir sunum yapmak istedim
      Veriyi kendim de bulabilirdim, ama sürümler arası karşılaştırmayı çok kolay hâle getiriyor

  • Birkaç ay önce yazdığım “SWEs want offline docs” blog yazısına tekrar baktım: https://technicalwriting.tools/posts/offline-docs/
    Dokümanların çevrimdışı tüketime uygun olduğunu bildirebilen RSS benzeri bir teknoloji var mı? Service worker gibi bir şeyden değil, kullanıcının dokümanları çevrimdışı okuyabilmesini sağlayan standartlaştırılmış bir formattan söz ediyorum
    Şimdiye kadar gördüklerim PDF ve ZIP olarak paketlenmiş bağımsız HTML sitelerinden ibaret. Başka bir şey var mı? Tam olgunlaşmamış bir düşünce, ama zaten var da ben bilmiyor muyum merak ediyorum

    • ZIP'ten daha iyi bir şey var mı emin değilim. Web sitemizde[0] oyun motoru dokümanları, Zig paket dokümanları vb. var; footer'da “offline version of this site” bağlantısı koyup yaklaşık 80 MB'lık bir ZIP dosyası sunuyoruz
      ZIP'in zorluğu, kullanıcının tüm görselleri mi, tüm sürümlerin dokümanlarını mı, yoksa yalnızca belirli bir sürümü mü istediğine uyarlamanın zor olması. Yine de ZIP hâlâ en iyi seçenek gibi görünüyor
      [0] https://machengine.org/
    • Tam bir cevap değil ama çevrimdışı dokümantasyon ve yerel/çevrimdışı tüketim için metin standardı Markdown; ya da öyle olmasını isterdim. Zaten ben neredeyse her zaman yalnızca Markdown ile yazıyorum, genellikle http://obsidian.md kullanıyorum
      Dokümanları indiren RSS benzeri bir servis olarak bildiğim en yakın şey Dash for macOS - API Documentation Browser, Snippet Manager - Kapeli
    • CHM[0] tam olarak böyle bir şey, ancak Windows merkezli. Yerel görüntüleyicide nasıl göründüğüne dair bir örnek burada[1] var
      Microsoft'un bunu bırakmış olması üzücü; AutoHotKey gibi bazı projeler hâlâ kullanıyor
      [0] https://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help
      [1] https://www.helpsmith.com/images/ss/chm-help1.png
    • Zeal kullanıyordum. Henüz her şey yok, ama içimi epey rahatlatıyor
    • Sadece bana öyle geliyor olabilir ama Emacs Info dokümantasyonu bu amaç için gerçekten iyi ve araya girmiyor

  • Uzun bir yolculuktan önce kontrol listemin üzerinden geçiyorum. Uçuş sırasında geliştirme yapmak istersem diye dil ve API dokümanlarını indiriyorum; bu harika aracı paylaşmak istedim
    Birçok dil ve API dokümantasyonuna kolayca çevrimdışı erişim sağlıyor. Biraz Zig tekrarı yapıp Vulkan ile eğlenceli bir şeyler denemeyi düşünüyorum. Mutlu yıllar

  • Yoldayken programlama yaparken faydalı oldu. Özellikle WiFi dengesiz olduğunda iyi
    Dokümanların tek yerde toplanmış olmasını da seviyorum. man, MDN ve DevDocs tek bir standart arayüzde birleşse üretkenlik ciddi biçimde artar gibi geliyor

  • Programcıların işi can sıkıcı sorunlara sistematik çözümler üretmek, ama kendi en temel ihtiyacımızın hâlâ düzgün çözülmemiş olması bana biraz şaşırtıcı geliyor
    Örneğin DevDocs'ta sık kullandığım epey kütüphane eksik; Python için Selenium binding'leri gibi. Dash'i de denedim ama OpenAI dokümanları gibi şeyleri doğrudan getiremediğim için sonunda web sitesine gitmek zorunda kaldım
    Yani yapılandırılmış içerikte hızlı arama yapmaya yarayan Dash'in harika özelliğinden mahrum kalmış oldum; bu da oldukça ironik geliyor

  • Yakın zamanda 14 saatlik bir uçuşta bunu kullandım. Boşa gidecek bir gün, inanılmaz üretken bir güne dönüştü
    Dikkat dağıtıcı unsur yoktu; ara sıra aklıma gelen sorulara da dokümantasyon yanıt verdi. Sadece bağlantıyı kesmek istediğinizde de gerçekten harika

    • Gerçekten iyi görünüyor. Bazen yapabileceklerinizin kısıtlanması, tersine özgürlük sağlayabiliyor
      Modern Linux netbook’u ne olurdu? Web’de gezinmek için performansı çok düşük olduğu için odaklanmak zorunda bırakacak küçük bir makine istiyorum
      Chromebook bu yeri almış olabilir ama hayatıma daha fazla Google sokmak istemiyorum

  • dedoc, DevDocs’u CLI’dan indirip arayabileceğiniz ve okuyabileceğiniz çevrimdışı bir CLI aracı. Bağlamı tarayıcıya kaydırmaktan kaçınmanın iyi bir yolu; tarayıcının kendi dikkat dağıtıcı unsurlarından da uzak tutuyor
    https://github.com/toiletbril/dedoc
    Rust ile statik olarak derlendiği için ikili dosyayı indirip kurmanız yeterli

  • Açık kaynak Dash’e (https://kapeli.com/dash) benziyor. Güzel

    • Zaten açık kaynak bir Dash var (https://zealdocs.or). Ancak Dash’in bazı listelerini kullanmaya dair sözleşme nedeniyle Mac derlemesi sunmuyorlar
      Yine de Mac’te kendiniz derleyebilirsiniz (https://github.com/zealdocs/zeal/wiki/Build-Instructions-for...)
    • Linux’a döndükten sonra Dash’i çok özledim. Yapılacaklar listemde web tabanlı bir klon yapmak var; Dash’in öldürücü özelliği olan özel paketleri de desteklemeyi planlıyorum
      Tarayıcıya bağlam değiştirmeye gerek kalmaması için üst düzey Emacs entegrasyonu da eklemek istiyorum
      Şu anda önce başka bir projeyi yayımlamakla meşgulüm, bu yüzden buna daha sonra dönmem gerekecek. hexdocs.pm ve MDN sekmelerinden her zaman bir iki tane açık tutmak zorunda kaldığım için üretkenliğim ciddi biçimde düştü
    • Kullanıcı katkılı doküman setleri de var; Dash barındırıyor: https://zealusercontributions.vercel.app/
    • Dash, readthedocs.org’daki dokümantasyonu da gerçekten kolayca içe aktarabiliyor; DevDocs’ta ise bu özellik yok

  • Bu harika. Daha önce bilseydim keşke
    Yalnızca resmi dokümantasyon sonuçlarını aradığınızı bildiğinizde web arama motorlarından çok daha iyi ve ayrıca çok daha hızlı. Bir kopyasını indirip yerelde çalıştırmayı ya da barındırmayı düşünüyorum

  • Bu aracı seviyorum. Emacs paketi[1] olarak her gün kullanıyorum ve iş akışının Dash tarzı çözümlerden çok daha akıcı olduğunu hissettim
    [1]: https://github.com/astoff/devdocs.el