5 ms·
Doctree
- mountainriver 5y agoI’m getting “server not found” when I click on the web page
- bradleyjkemp 5y agoAnd it's not just DNS issues. The domain doesn't even seem to be registered: it's available for purchase... edit: No longer! Hopefully someone benevolent picked it up
- mdaniel 5y agoSweet, a phishing opportunity! | Welcome to the doctree.dev demo site! |--- | Enter your github oauth2 token to see it work
- devass 5y agoProbably some developer misusing the .dev domain for their own personal test projects, yet again.
- HWR_14 5y agoYou mean "some dev deciding to keep using the .dev for personal test projects, as was the standard before ICANN and Google took a standard community resource and privatized it, yet again"
- chrisseaton 5y ago> as was the standard Which standard was that? I thought only example.com was special-cased?
- HWR_14 5y agoBefore ICANN started auctioning off TLDs it was common practice to use .dev and .test (probably others that escape me). It wasn't formalized, but that doesn't really matter. It was well known and commonly done. In fact, it couldn't have been formalized, because the TLDs were limited and by definition any non standard TLD was for internal use only. It would make no sense to have a defined standard for an impossible situation.
- detaro 5y ago> In fact, it couldn't have been formalized, because the TLDs were limited and by definition any non standard TLD was for internal use only. No, there never was any guarantee that the existing TLDs were all that would exist ever, so non-standard TLDs were just that: non-standard, undefined what happens to them. And you even provided a counter-example: .test is explicitly reserved by an internet standard to never be in public DNS and thus safe to use for testing purposes.
- chrismorgan 5y agoUsing .dev was always contrary to spec. Dunno how common it actually was—I personally never encountered it. Clearly ICANN decided it wasn’t such a hazard as .home and .corp, which are both indefinitely delayed (https://icannwiki.org/Name_Collision https://icannwiki.org/Name_Collision) due to their popularity (despite being contrary to spec). You should instead have used something like .localhost (reserved in RFC 2606) if it’s on your local machine, or .test (reserved in RFC 2606) in a local network, or some domain that you control (even if it’s not publicly routable).
- my69thaccount 5y agohttps://github.com/basecamp/pow https://github.com/basecamp/pow Pow used .dev and .test in the 2000s-2010s
- chrisseaton 5y agoThat’s not a standard that’s just someone using them.
- slimsag 5y agoTo be clear, we do own the domain. It was registered about ~7 days ago. It's just not deployed yet.
- bradleyjkemp 5y agoMay want to double check that: domain data shows it was only registered today about an hour ago: https://client.rdap.org/?type=domain&object=doctree.dev https://client.rdap.org/?type=domain&object=doctree.dev It was definitely available to purchase when I commented
- slimsag 5y ago..huh, yep, you're right. That's.. super embarrassing and huge screw up on my part, uhg. I was 100% positive I submitted the order through Namecheap before pushing the repo up to GitHub for this exact reason, and that it went through.. but yeah, looks like I didn't and we don't own it. :( Good news is we've got doctree.org, so will be using that instead. I've removed all references to the other domain. If it was a good samaritan, shoot me an email -> stephen@sourcegraph.com
- __ryan__ 5y agoI love namecheap but I have walked away thinking I’ve completed an order to find that there’s a second order confirmation screen numerous times.
- slimsag 5y agoThis was probably it.. luckily, it seems like it may have been a good samaritan from HN, they reached out to me just now. People here rock :)
- mdaniel 5y agoUnless "tosh" is one of the project authors, I'd guess this was submitted to HN before an official launch. That is, I bet there are a lot of broken links from the website field in GitHub projects, and the only reason you expected this one to work was because it made the front page of HN and was in sourcegraph's GitHub org
- tosh 5y agofound it via the author’s tweet: https://twitter.com/slimsag/status/1519910761400741888 https://twitter.com/slimsag/status/1519910761400741888
- rvieira 5y agoIncidentally, I've been getting a lot of timeouts from .dev TLDs today.
- beliu 5y agoI’m helping with the doctree effort at Sourcegraph. Apologies, the site isn’t actually up yet. This project is still very early stages and we wrote up the README to serve as a sort of launch spec that we could update in response to feedback we receive. We made the repo public so we could build in public but didn’t expect it to receive this much attention this early! So sorry that the site isn’t up yet. We’ll update the README soon to reflect that. If folks are interested in trying out a super early version, there’s the Docker run command and if you’d like to help us realize this vision, please join our Discord! https://discord.gg/vqsBW8m5Y8 https://discord.gg/vqsBW8m5Y8
- brainbag 5y agoI've been wanting this to exist for years, ever since using Elixir and the amazing first class doc support. I hope it is super successful!
- pizza 5y agoInteresting - wonder if there's a way to combine this with fzf + some kind of html or e.g. markdown viewer to search and read docs straight in the terminal
- slimsag 5y agoSince `doctree` will be a static Go binary you can run locally, the idea is to have a "get docs straight in the terminal" via the CLI in the future. But probably a little ways away from that since we're just a week into it!
- qbasic_forever 5y agoIf the docs are generated from comments in the code a simple ripgrep search of the source (with fzf or other integration) will find things just as well too. Hound is a nice little web UI that does this: https://github.com/hound-search/hound https://github.com/hound-search/hound
- slimsag 5y agoWhoa, wasn't expecting to see this on HN! I've only done a week of work on this, super early stages - here are our plans for it: * 100% OSS tool, run locally on your machine (static Go binary) or use https://doctree.org https://doctree.org (not online yet, plug in a repository name, get docs) - really want this to be a proper, useful FOSS tool. * Work with any language, based on tree-sitter. * Provide symbol-level search functionality. * Surface real-world usage examples automatically, probably based on some statistical analysis of how functions are commonly used in open source code via Sourcegraph API, similar to what https://codestat.dev https://codestat.dev is doing. Tech details (again, just a week in): * Go for backend, Elm for frontend * Indexers will be written in Go, use tree-sitter queries to produce a standard index schema which then gets served to Elm frontend for rendering. https://github.com/sourcegraph/doctree/blob/main/doctree/schema/schema.go https://github.com/sourcegraph/doctree/blob/main/doctree/sch... Probably not worth trying out right now, but if you're interested in it we set up a Discord server for collaboration, etc. https://discord.com/invite/vqsBW8m5Y8 https://discord.com/invite/vqsBW8m5Y8 Happy to answer any questions!
- learndeeply 5y agoWhy is this open source? Sourcegraph could make this a successful paid, enterprise product.
- slimsag 5y agoFair question! I want to say really, the goal is just to find a way to make an actually useful library documentation tool like this that people enjoy using. Myself, Beyang (CTO), and Quinn (CEO) have all wanted something like this for a while and think there's potential for something cool here. It'll require _a lot_ of iteration to make this work really well, though, and make it something that everyone feels good about using *for their projects*. Don't want there to be barriers to using it, if it was enterprise/paid it'd be tough to do that. There will be features/functionality doctree _can_ gain if you connect it to a Sourcegraph instance, but largely because they'd be impossible to do otherwise: * Usage examples - we need statistical analysis of a large corpus of open source code to find good real-world usage examples, so we'll leverage Sourcegraph for that (it already has that data.) * Respecting repository permissions, OAuth integration, etc.; very important in enterprise environments, super complex/annoying to do. Sourcegraph already has all this data about your github/gitlab/bitbucket repos, user accounts, etc. and so maybe you can one-click connect doctree to a Sourcegraph instance to gain this functionality if you're some large enterprise that needs it. I think there are some great synergistic ways doctree will work with Sourcegraph if you use that (or are OK with it contacting Sourcegraph.com for public code, but very important to make that respectful / opt in.) I want to be clear, though, doctree is 100% open source, it'll be a proper OSS project - just want to make a useful tool for everyone first and foremost.
- jitl 5y agoI'm ecstatic that someone is building this. Figuring out sourcecode-to-apidocs for one language is annoying, and figuring it out in the context of multi-language monorepos is exhausting. Then on top of that, I want to fail the build if someone adds public APIs to a library and doesn't document them! Now I have to go back to all my doc generators and get some kind of metadata out of them??????? And what if I want to make my docs pretty, and link to each other across languages?????? SFLSJHDFKJSDHKJF So, this is great. A small dream, coming true. Best of luck to y'all!
- mhh__ 5y agohttps://mir-algorithm.dpldocs.info/mir.ndslice.html https://mir-algorithm.dpldocs.info/mir.ndslice.html is a D specific approach to something like this (it doesn't use the same approach as the builtin doc generator you get with the D compiler, e.g. everything appears in the docs just some things are noted as being undocumented)
- patrick451 5y agoThis seems like a really slick idea. Something I've always wanted is better multi-language documentation support. kLike suppose I have a c++ project that is integrated to python with pybind11. The python bindings may be the highlevel interface, but sphinx doesn't make it easy (as far as I know) to integrate python documentation generated from doc strings with c++ doxygen style briefs, especially in a way that lets you navigate seamlessly between the two. I wonder if you have considered a use-case like this?
- slimsag 5y agoDefinitely want to enable this use case better. I think it will be quite easy to have a "you're viewing your project, you search for a function named 'curl fetch' and it turns up both the Python and C++ method named that"-type experience. Linking between the two may be tougher (showing you with confidence they're related), but maybe possible for us to do something there, not sure yet.