DevDocs: कई तकनीकी दस्तावेज़ों को एक जगह खोजने वाला डॉक्यूमेंटेशन प्लेटफ़ॉर्म

 (devdocs.io)
3 पॉइंट द्वारा GN⁺ 2024-01-14 | 1 टिप्पणियां | WhatsApp पर शेयर करें
  • डेवलपर्स द्वारा अक्सर खोजे जाने वाले API दस्तावेज़ एक जगह इकट्ठा करके तेज़ी से search करना संभव बनाता है, जिससे language और framework के हिसाब से अलग-अलग docs में जाने की लागत घटती है
  • डिफ़ॉल्ट रूप से CSS, HTML, HTTP, JavaScript, Web APIs दिखते हैं, और Preferences में ज़रूरी दस्तावेज़ों को और enable करके स्क्रीन को adjust किया जा सकता है
  • bgcp से background-clip खोजने जैसी fuzzy matching और दस्तावेज़-विशेष search scope तय करके मनचाही entries तक जल्दी पहुँचा जा सकता है
  • माउस के बिना इस्तेमाल के लिए keyboard shortcuts, browser address bar search, mobile उपयोग, और web app installation को support करता है
  • ऑफ़लाइन भी दस्तावेज़ देखे जा सकते हैं, और यह एक मुफ्त open source project है, इसलिए development environment के मुताबिक बिना झिझक इस्तेमाल किया जा सकता है

कई API दस्तावेज़ों को एक जगह search करना

  • DevDocs कई API दस्तावेज़ों को एक तेज़ और व्यवस्थित search interface में जोड़ता है
  • default screen पर CSS, HTML, HTTP, JavaScript, Web APIs दस्तावेज़ दिखते हैं
  • Preferences में और अधिक दस्तावेज़ enable किए जा सकते हैं और UI customization की जा सकती है

Search और navigation का तरीका

  • search fuzzy matching को support करता है
    • उदाहरण के लिए, bgcp टाइप करने पर background-clip मिल सकता है
  • जब किसी खास दस्तावेज़ के अंदर ही खोजना हो, तो दस्तावेज़ का नाम या abbreviation टाइप करने के बाद Tab से search scope को संकरा करें
  • browser address bar search भी इस्तेमाल किया जा सकता है, और setup करने का तरीका guide में देखा जा सकता है

Keyboard-केंद्रित उपयोग

  • माउस के बिना भी navigation और search की जा सकती है
  • keyboard shortcuts की सूची देखें या उपलब्ध shortcuts देखने के लिए ? दबाएँ

Offline और installation support

  • DevDocs offline भी काम करता है
  • इसे mobile पर इस्तेमाल किया जा सकता है, और web app के रूप में install किया जा सकता है

मुफ्त open source project

  • DevDocs मुफ्त में उपलब्ध है
  • source code GitHub पर public है
  • latest news @DevDocs account पर देखी जा सकती है
  • coding शुरू करने वाले users के लिए freeCodeCamp का open source curriculum भी जुड़ा हुआ है

संबंधित पढ़ाई

1 टिप्पणियां

 
GN⁺ 2024-01-14
Hacker News की राय

  • मैं कुछ गिने-चुने DevDocs maintainers में से एक हूँ
    जब तक documentation system या design पूरा बदल न जाए, नए release के हिसाब से docs अपडेट करना आसान होता है। हालांकि react.dev redesign जैसे कुछ projects शायद ऐसे बड़े बदलाव काफी अक्सर करते हैं
    कुछ documentation generators Gatsby द्वारा docs.npmjs.com पर बनाए गए .gtWOdv, .ezMiXD, .gOhcvK जैसे random class names बनाते हैं, जिससे page navigation जैसी गैर-ज़रूरी चीज़ें हटाने का काम झंझटभरा और fragile हो जाता है
    हम हर महीने outdated docs की list अपने-आप generate करते हैं और latest list यहाँ है: https://github.com/freeCodeCamp/devdocs/issues/2105
    मदद का हमेशा स्वागत है

    • simon04, बहुत समय पहले maintainers ने जो काम किया था, उसने मेरे career और बाद में मेरी जिंदगी पर भी बड़ा फर्क डाला
      जल्दबाज़ी में लिए गए software work के दौरान commute करते समय offline docs पढ़ पाना सच में बहुत अहम था
      हो सकता है devdocs में मदद करके आपने एक पैसा भी न कमाया हो, लेकिन कृपया यह जरूर जानें कि आप वास्तविक लोगों की मदद कर रहे हैं
    • यह app मुझे निजी तौर पर काफी frustrating लगती है। यह docs के बेहतरीन sources में से एक है, लेकिन मेरे चुने हुए docs की list बनाए नहीं रख पाती, इसलिए लगभग इस्तेमाल लायक नहीं रह गई है
      लगभग हर बार visit करने पर मुझे अपना stack फिर से शुरुआत से चुनना पड़ता है। यह शानदार है, लेकिन इतना भी शानदार नहीं कि यह काम बार-बार करता रहूँ
      मुझे दूसरी जगह cookies या local storage गायब होने की समस्या नहीं होती, और मैं latest Linux Chrome इस्तेमाल कर रहा हूँ। कोई अंदाज़ा कि वजह क्या हो सकती है?
    • क्या आप documentation generators को इस आधार पर rate कर सकते हैं कि वे consume करने में कितने आसान हैं?
      मैं जानना चाहता हूँ कि semantic extraction की आसानी के लिहाज़ से Sphinx, Docsy, MkDocs, Docbook वगैरह की तुलना कैसी है
    • एक technical interview में मुझसे पूछा गया था कि किसी framework में XYZ कैसे करूँगा
      मैंने कहा कि मुझे ठीक-ठीक नहीं पता, लेकिन devdocs.io पर API interface देखकर और समझने की कोशिश करूँगा
      interviewer को समझ नहीं आया कि मेरा क्या मतलब है, इसलिए उसने laptop पर खुद खोलकर देखा, और काफी प्रभावित हुआ
      बेशक मुझे वह job नहीं मिली, लेकिन interview table के दूसरी तरफ knowledge फैलाना काफी cool लगा
    • यह site ऐसे contributions की वजह से ही जिंदा है, और इसी के चलते मुझे Python 3.8 के बाद के अपने पसंदीदा updates पर presentation देने का मन हुआ
      data मैं खुद भी ढूँढ सकता था, लेकिन इसने version-by-version comparison को बहुत सुविधाजनक बना दिया

  • कुछ महीने पहले लिखा अपना “SWEs want offline docs” blog post फिर से देखा: https://technicalwriting.tools/posts/offline-docs/
    क्या कोई RSS जैसी technology है जिससे बताया जा सके कि docs offline consumption के लिए उपयुक्त हैं? मेरा मतलब service workers जैसी चीज़ से नहीं, बल्कि ऐसे standardized format से है जिससे user docs offline पढ़ सके
    अब तक मैंने सिर्फ PDF और ZIP में bundled standalone HTML sites ही देखी हैं। क्या कुछ और है? यह अभी अधपका विचार है, लेकिन जानना चाहता हूँ कि क्या ऐसा पहले से है और मुझे पता नहीं

    • मुझे नहीं पता ZIP से बेहतर कुछ है या नहीं। हमारी website[0] में game engine docs, Zig package docs वगैरह हैं, और footer में “offline version of this site” link देकर लगभग 80MB की ZIP file देते हैं
      ZIP की कठिनाई यह है कि user को सारी images चाहिए या नहीं, docs के सभी versions चाहिए या सिर्फ कोई particular version—इन जरूरतों के हिसाब से ढालना मुश्किल है। फिर भी ZIP अभी भी सबसे अच्छा लगता है
      [0] https://machengine.org/
    • पूरा जवाब तो नहीं, लेकिन offline docs और local/offline consumption के लिए text का standard Markdown है, या कम से कम होना चाहिए। वैसे भी मैं लगभग हमेशा Markdown में ही लिखता हूँ, आम तौर पर http://obsidian.md का उपयोग करता हूँ
      docs download करने वाली RSS जैसी service में मेरे जानने में सबसे करीब Dash for macOS - API Documentation Browser, Snippet Manager - Kapeli है
    • CHM[0] बिल्कुल यही है, लेकिन Windows-केंद्रित है। native viewer में यह कैसा दिखता है, उसका example यहाँ[1] है
      अफसोस है कि Microsoft ने इसे छोड़ दिया, और AutoHotKey जैसे कुछ projects अभी भी इसका उपयोग करते हैं
      [0] https://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help
      [1] https://www.helpsmith.com/images/ss/chm-help1.png
    • मैं Zeal इस्तेमाल करता आया हूँ। अभी उसमें सब कुछ नहीं है, लेकिन मन काफी निश्चिंत रहता है
    • शायद सिर्फ मुझे ऐसा लगता हो, लेकिन Emacs Info docs इस काम के लिए सच में बहुत अच्छे हैं और distract भी नहीं करते

  • लंबी यात्रा से पहले checklist देख रहा हूँ। flight में development करना चाहूँ तो उसके लिए languages और API docs download कर रहा हूँ, और यह शानदार tool share करना चाहता था
    यह कई languages और API docs तक आसानी से offline access देता है। मैं Zig थोड़ा revise करने और Vulkan के साथ कुछ मज़ेदार करने का सोच रहा हूँ। नया साल मुबारक हो

  • सफर के दौरान programming करते समय यह उपयोगी रहा। खासकर जब WiFi unstable हो
    docs का एक जगह इकट्ठा होना भी अच्छा लगता है। अगर man, MDN, DevDocs एक standard interface में merge हो जाएँ, तो productivity काफी बढ़ जाएगी

  • programmers का काम परेशान करने वाली problems के systematic solutions बनाना है, लेकिन यह देखकर थोड़ा हैरानी होती है कि हमारी अपनी सबसे basic जरूरतें अभी भी ठीक से हल नहीं हुई लगतीं
    उदाहरण के लिए DevDocs में मेरी अक्सर इस्तेमाल की जाने वाली कई libraries नहीं हैं, जैसे Python के लिए Selenium bindings। Dash भी आज़माया, लेकिन OpenAI docs जैसी चीज़ें सीधे import नहीं कर सका, इसलिए आखिरकार website पर ही जाना पड़ा
    यानी structured content को तेजी से search करने की Dash की शानदार capability मुझसे छिन गई, जो काफी ironic लगता है

  • हाल की 14 घंटे की उड़ान में मैंने इसे इस्तेमाल किया। जो एक बर्बाद होने वाला दिन था, वह बेहद उत्पादक दिन में बदल गया
    कोई distraction नहीं था, और बीच-बीच में उठने वाले सवालों के जवाब docs ने दे दिए। जब बस disconnect होना हो, तब भी यह सच में बढ़िया है

    • सच में अच्छा लग रहा है। कभी-कभी आप क्या कर सकते हैं, इस पर सीमाएँ होना उल्टा आज़ादी देता है
      आधुनिक दौर का Linux netbook क्या होगा? मुझे ऐसी छोटी machine चाहिए जिसकी performance web browse करने के लिए बहुत कम हो, ताकि focus करने के अलावा विकल्प ही न बचे
      शायद Chromebook ने वह जगह ले ली हो, लेकिन मैं अपनी ज़िंदगी में Google को और नहीं लाना चाहता

  • dedoc एक offline CLI tool है जिससे CLI में DevDocs download, search और read किया जा सकता है। browser में context switch करने से बचने का अच्छा तरीका है, और browser के अपने distractions से भी बचा सकता है
    https://github.com/toiletbril/dedoc
    Rust में statically compile किया गया है, इसलिए binary download करके install कर सकते हैं

  • open source Dash(https://kapeli.com/dash) जैसा है। अच्छा है

    • open source Dash पहले से है(https://zealdocs.or). हालांकि Dash की कुछ lists इस्तेमाल करने के agreement की वजह से Mac build provide नहीं करता
      फिर भी Mac पर खुद build कर सकते हैं(https://github.com/zealdocs/zeal/wiki/Build-Instructions-for...)
    • Linux पर लौटने के बाद Dash की बहुत कमी महसूस हुई। मेरी to-do list में web-based clone बनाना है, और Dash की killer feature रहे custom packages को भी support करने की कोशिश है
      browser में context switch न करना पड़े, इसके लिए top-tier Emacs integration भी जोड़ना चाहता हूँ
      अभी पहले दूसरे project का launch कर रहा हूँ, इसलिए बाद में फिर इस पर लौटना होगा। hexdocs.pm और MDN के एक-दो tabs हमेशा खुले रखने पड़ते हैं, जिससे productivity काफी घट गई है
    • user-contributed doc sets भी हैं, Dash उन्हें host करता है: https://zealusercontributions.vercel.app/
    • Dash readthedocs.org के docs भी सच में आसानी से import कर सकता है, लेकिन DevDocs में यह feature नहीं है

  • यह शानदार है। काश इसके बारे में पहले पता होता
    जब पता हो कि आप सिर्फ official docs results ढूंढ रहे हैं, तो यह web search engine से कहीं बेहतर है, और speed भी बहुत ज्यादा है। इसका copy लेकर local पर run या host करने का सोच रहा हूँ

  • मुझे यह tool पसंद है। Emacs package[1] के जरिए रोज़ इस्तेमाल करता हूँ, और Dash-टाइप solutions की तुलना में इसका workflow कहीं ज्यादा smooth लगा
    [1]: https://github.com/astoff/devdocs.el