17 ms·
DevDocs
- hprotagonist 3y agoemacs integration: https://github.com/astoff/devdocs.el https://github.com/astoff/devdocs.el
- jakogut 3y agoHey, folks. I'm running down my checklist before a long trip. I'm preparing by downloading language and API docs in case I want to do some development in the air and figured I'd share this great tool. It allows for easy offline documentation access for a lot of languages and APIs. I'm hoping to brush up on some Zig and maybe do something fun with Vulkan. Happy new year!
- esafak 3y agoLike an open source Dash (https://kapeli.com/dash https://kapeli.com/dash). Noice!
- bluish29 3y agoThere is already open source dash (https://zealdocs.or https://zealdocs.or) although they don't provide Mac build because of an agreement to use some of dash's lists. But you can build it on mac (https://github.com/zealdocs/zeal/wiki/Build-Instructions-for-macOS https://github.com/zealdocs/zeal/wiki/Build-Instructions-for...)
- hu3 3y agotypo in URL: https://zealdocs.org/ https://zealdocs.org/
- sph 3y agoI've been missing Dash so much since I moved back to Linux, on my todo list is to create a Web based clone, that supports custom packages which was Dash's killer feature. And with top class Emacs integration, instead of having to context switch to a browser. Currently focused on launching another project and I will have to get back to it, my productivity has tanked now that I constantly need to have a browser tab or three open on hexdocs.pm and MDN
- kelsolaar 3y agoDash makes it really easy to pull docs from readthedocs.org also, this is something devdocs does not have.
- adhesive_wombat 3y agoThere's also the user-contributed (but Dash-hosted) docsets: https://zealusercontributions.vercel.app/ https://zealusercontributions.vercel.app/
- kosasbest 3y agoMDN[0] is usually my goto reference for frontend stuff. I know DevDocs has the offline feature, but frankly I can't develop without an Internet connection. I tried it, and failed terribly. Besides MDN, developers need quick access to Google and ChatGPT to go forward, quickly. [0] https://developer.mozilla.org/en-US/ https://developer.mozilla.org/en-US/
- SparkyMcUnicorn 3y agoI was recently on a flight where the "wifi is down" and wanted to get some coding done. I already had some LLM models downloaded, so I quickly pulled down the fauxpilot repo and made sure I had everything needed for when we were in the air. My expectations were really low, but I was surprised at how productive I was with just DevDocs and an LLM. I might have even been more productive than normal because there wasn't any internet distractions.
- imbnwa 3y agoBeen relying on this site for years
- filedottsx 3y agoFirst time I've come across it. It's great!
- imbnwa 3y agoOh yeah, having a one-stop-shop for docs that can act offline is so useful. It has an API and I a have Neovim plugin that provides its feature set in my running neovim instance. If they were to get more mobile/platform-specific stuff like Apple docs, Android, Windows especially (all of the supported SDKS lol) it would be a magical place. Now add the ability to comment on docs like the PHP docs and we're _really_ setting off
- vinnymac 3y agoWhen programming on the go, I’ve found this to be useful. Especially if the WiFi is flaky. I also enjoy having documentation consolidated. If man, mdn, and devdocs were combined into a single standard interface it would be a great boost to my productivity.
- kaycebasques 3y agoI just revisited my "SWEs want offline docs" blog post from a few months back: https://technicalwriting.tools/posts/offline-docs/ https://technicalwriting.tools/posts/offline-docs/ Is there any kind of technology similar to RSS that lets you announce that your docs are offline-consumption-friendly? I don't mean service workers or anything like that. I mean some kind of standardized format for enabling users to read your docs offline. All I've ever seen are PDFs and self-contained HTML sites packaged as a ZIP. Anything else? Half-baked idea, but just asking in case something already exists and is not on my radar...
- sleepytree 3y agoNot a complete answer, but I hope Markdown is or becomes the standard for offline docs and text for local/offline consumption. I only ever write in markdown anyway (usually with http://obsidian.md http://obsidian.md). The closest thing I know of for a service like RSS to download documents is [Dash for macOS - API Documentation Browser, Snippet Manager - Kapeli](https://kapeli.com/dash https://kapeli.com/dash).
- 0cf8612b2e1e 3y agoMarkdown is too anemic for documentation without extensions. Sure, you can make do, but I would rather wet standardized on something more powerful.
- djbusby 3y agoI'm still loving asciidoc. Loads of extensions too so I can have PlantUML and Mermaid stuff too
- SpaghettiCthulu 3y agoI agree. We need a standardized format with support for both structured (classes, methods, etc.) and unstructured (language overview) documentation..
- packetlost 3y agoThere's also Zeal (https://zealdocs.org/ https://zealdocs.org/) which is basically the same as Dash but open source and runs on non-Mac devices.
- LordDragonfang 3y agoI love devdocs, but I'm forever salty that they don't include C# as one of their languages.
- tonymet 3y agoif the C# docs have a flexible license , then you could add them
- LordDragonfang 3y agoUnfortunately it seems to be the opinion of whoever controls the devdocs language requests[1] that the MSDN boilerplate license[2] is not permissive in this regard. However, devdocs is notable enough that they could easily at least ask for the written permission. [1] https://trello.com/c/PVnfdeaN/26-suggest-new-docs-here https://trello.com/c/PVnfdeaN/26-suggest-new-docs-here [2] https://learn.microsoft.com/en-us/legal/termsofuse https://learn.microsoft.com/en-us/legal/termsofuse
- Pathogen-David 3y agoCertain parts of Microsoft Learn are permissive, most .NET/C# documentation is Creative Commons Attribution: * Conceptual docs: https://github.com/dotnet/docs https://github.com/dotnet/docs * BCL: https://github.com/dotnet/dotnet-api-docs https://github.com/dotnet/dotnet-api-docs * ASP.NET Core: https://github.com/dotnet/AspNetCore.Docs https://github.com/dotnet/AspNetCore.Docs * WinForms/WPF: https://github.com/dotnet/docs-desktop https://github.com/dotnet/docs-desktop The C# language specification is unfortunately a bit fuzzier, but the conceptual docs above include what most people want: https://github.com/dotnet/csharplang/discussions/4855 https://github.com/dotnet/csharplang/discussions/4855 The updated unified C# language specification is CC, but it's still catching up to modern C#: https://github.com/dotnet/csharpstandard https://github.com/dotnet/csharpstandard
- jve 3y agoMS docs ar now on github. Licence lists "CC-BY-4 and MIT licence found" https://github.com/dotnet/docs/tree/main https://github.com/dotnet/docs/tree/main Yeah, I saw that devdocs and the like don't include what was previously not cross platform and not popular for linux guys: C#, msbuild.
- Apreche 3y agoThank you. This is terrific. Wish I knew about it earlier. So much better than using web search engines when I know I'm only looking for results from official documentation. Also so much faster. I think I'll get a copy and run/host it locally.
- baal80spam 3y agoGetting quite a few 404s on various links...
- nu11ptr 3y agoI'm not familiar with this, can someone give some context? I assume this is all harvested from other sources and just gathered here? Or is there some original content? How up to date is it typically?
- bmartin13 3y agoThis is amazing! Mad props to whoever helped get this running. I would love to see C# in this list!
- rubenv 3y agoOnly gripe here, and it's not a devdocs problem per se, is that Firefox deletes the offline documentation if you haven't opened devdocs in a while. Is there any way I can turn that off, preferably on a per-site setting?
- voytec 3y agoThis site's cookies seem to be issued for some 2 months. You can extend cookies' lifetime in Firefox globally and per-site but a cookie can (and in most cases should) be invalidated on the server side.
- tonymet 3y agodedoc is an offline CLI tool to download, search , read devdocs from your CLI. great way to help avoid context-switching to the browser (which has it's own distractions) https://github.com/toiletbril/dedoc https://github.com/toiletbril/dedoc It's statically compiled in rust so you can download and install the binary
- johncoltrane 3y agoFWIW, a little Vim plugin for searching DevDocs: https://github.com/romainl/vim-devdocs https://github.com/romainl/vim-devdocs
- pocketarc 3y agoUsed this on a 14 hour flight recently. It turned it from a wasted day to an insanely productive one. No distractions, and the docs were there to answer the occasional question. It’s so good even if you just want to unplug.
- plagiarist 3y agoSounds fantastic. Sometimes the restrictions on what you can do are freeing. What's the modern equivalent of a Linux netbook? I want a little machine that's too underpowered to browse the web so I have no choice but to concentrate. Maybe Chromebooks have taken that spot but I don't want more Google in my life.
- isr 3y agoSounds like you want a refurbished older thinkpad. x230 with the classic 7 row keyboard. Max out the ram. Maybe replace the screen with a newer 13" panel? There's a whole subculture of thinkpad-modders out there. If you're looking for a small formfactor, excellent keyboard, plenty of ports, not too pricy (inc mods), that might be your best option. YMMV.
- plagiarist 3y agoSounds great, except if I am able to mod it, that will be distracting on its own :)
- simon04 3y agoI'm one of the few maintainers. Updating docs to a new release is easy unless the documentation system (such as react.dev redesign) or design is rewritten. Some projects seem to do this on a regular basis. Some documentation generators generate random class names (such as .gtWOdv, .ezMiXD, .gOhcvK on docs.npmjs.com by Gatsby) which makes cleaning the docs from superfluous content (such as on-page navigation) very cumbersome and flaky. Monthly, we auto-generate a list of outdated docs, here is the latest: https://github.com/freeCodeCamp/devdocs/issues/2105 https://github.com/freeCodeCamp/devdocs/issues/2105 Help is always welcome. :-)
- rmbyrro 3y agoI'm thinking ChatGPT can probably do a lot of the heavy lifting in this cleaning step, have you considered integrating your app with OpenAI's API, or perhaps an open model like CodeLlama?
- withinboredom 3y agoDo you realize how much money that would cost? "just throw AI at it" is often some of the most expensive words uttered lately.
- Izmaki 3y ago"...but can't you just run it in the cloud?" :)
- airtonix 3y ago[dead]
- rmbyrro 3y agoWould you run in your basement?
- withinboredom 3y ago
- bomewish 3y agoKind of amazed that while programmers’ whole game is to develop systematic solutions to annoying problems… our own most basic need hasn’t been really met this way? For instance devdocs does not have a bunch of libraries that I use regularly (selenium bindings in python, etc). I also tried Dash but wasn’t able to just ‘get’ for eg the openai docs and had to go to their website. Meaning I was robbed of the cool features of dash, being able to quickly search structured content. Just seems ironic.
- zikani_03 3y agoI love this tool, and it's one of the tools I recommend to a lot of my fellow developers and emphasize the importance of RTFM. Thank you so much to the maintainers for keeping this going for so long! Love it and use it very often.
- have_faith 3y agoI’ve had this as a pinned tab in my browser for many years. Probably the only thing that has stayed the same in my browser over that time.
- bruh2 3y agoLove this tool. I use it daily via an Emacs package[1], and I found the workflow to be way smoother compared to dash-like solutions. [1]: https://github.com/astoff/devdocs.el https://github.com/astoff/devdocs.el
- dosourcenotcode 3y agoAs glad as I am that things like DevDocs and Zeal exist I feel like ultimately they are a crutch and indicative of a much larger problem in Open Source which I'm trying to address. Now as a FOSS maintainer I don't owe anyone any particular set of features or bug fixes. BUT I ABSOLUTELY DO OWE THEM ACTUAL OPENNESS AND THE ABILITY TO STUDY THE SYSTEM PROPERLY. Many FOSS projects frankly kneecap Freedom 1 with a sledgehammer for anyone who isn't a well off person with reliable Internet access. And I've been up to here with it for a very long time now. For all my FOSS projects big or small my pledge is to give users complete and trivial access to the full Open Knowledge Set associated with them. Not just the main program sources and executables, but built and source forms of any official documentation that exists. Withholding any official documentation that exists from trivial and easy offline access in a useful form is fundamentally no better than withholding any part of the source code. Period. End of story. My pledge for all my FOSS projects is as follows: At the home page people within 30 seconds of having read the Elevator Pitch and decided they want to study the system properly will be able to trivially enumerate and initiate downloads for all educational information related to it whether that's source code or built forms of the documentation usable for study straight away. How the Open Source Definition and Free Software Definition don't mandate something as common sense as this I don't know. Open Source and Open Knowledge should be for everyone, not just well off people with reliable Internet access. Anyway that's what caused me to start the Freedom Respecting Technology movement. Thus if anything I said here resonates with anyone they should read https://makesourcenotcode.github.io/freedom_respecting_technology.html https://makesourcenotcode.github.io/freedom_respecting_techn... to learn more.
- imiric 3y agoThat's a good idea, but I don't see why it deserves a manifesto, or the grandiose claims about being the "next generation" of open source. Just ship your software with documentation. This was a good practice even before open source or the internet took off. Old school closed source software used to ship with physical manuals, and good quality software often had good documentation as well. Some OSS CLI tools do have extensive manpages, yet users often don't read them in their entirety. So it's not just a matter of shipping good documentation, it's also about making it discoverable and easy to use. This is where projects like DevDocs step in.
- deleted 3y ago[deleted]
- arjunlol 3y agoAwesome, this is a great project
- deleted 3y ago[deleted]
- dcchambers 3y agoThis is awesome!! I use something similar on MacOS but it's a native app with offline support. The offline support is a neat feature but honestly these days if the internet is down I just don't do any development work... - https://kapeli.com/dash https://kapeli.com/dash
- naruhodo 3y agoWhere's Java? I can't find it in the Preferences, or in the Trello board of suggested languages or incompatible licensees.
- SpaghettiCthulu 3y agoIt's called "OpenJDK"
- guptaravi 3y agoHow can I help get Playwright in there?
- qazxcvbnm 3y agoThis is the resource I reach to whenever I need to find a Nix function.
- ayoisaiah 3y agoI've been using DevDocs in Neovim through this plugin: https://github.com/luckasRanarison/nvim-devdocs https://github.com/luckasRanarison/nvim-devdocs Works great, and don't ever have to leave my editor to read something
- marcoherbst 3y agoDevDocs but for Google Drive? I daydream about a DevDocs to use as an index for our company Google Drive. The goal being to create something like Notion or Almanac but without having to have a new place to write (google docs functionality is really great and hard to escape). We currently use Google Sites but it's so clunky and the search will not search inside Google Docs. Google Drive as is doesn't work as it is too full of too many things. Even well structured, it doesn't function as an Intranet, for us. I think the answer is that one just waits for Google to make their response to Notion/Loop, but post this in case someone knows of something like that or sees this a different way?
- djha-skin 3y agoThe lack of common lisp documentation underlines how difficult it is to find resources on how to use that language. Is the hardest googleable language I've learned so far.
- deleted 3y ago[deleted]