Live data from Hacker News

Documenting the Web together

blogs.windows.com

191–200 of 212 posts

Re: Documenting the Web together

#191

Earlier quoted context omitted.

In this case, there could be literally nothing instead. > (Today, we’re excited to share some big news for developers around the world wide web: )We’re committing our resources towards making MDN Web Docs the best place to go for web API reference.

There needs to be an intro or it sounds very weird.

Agreed. Keep the word "Today".

Re: Documenting the Web together

#193
post #21

Earlier quoted context omitted.

w3schools.com is a great resource. I prefer it when I need a quick refresher on an HTML element because it's especially good for having short, simple examples I can copy and paste. MDN tends to be verbose and technical. It's good when you need to know everything in detail, but often I need a quick refresher and a simple example and for that w3schools.com always seems to have better content. Compare these two pages fo…

the MDN example (unfortunately at the bottom of the page) is more correct by using a proper tag with the tag, while w3schools omits that detail, which makes it seem like plain text labels with tags (yuck) after them are ok (label tags add accessibility among other things). tl;dr: use 's with 's, not plain text labels, as MDN shows you to do.

Hi from one of MDN's writers!

So, we're aware that the examples being way at the bottom of the page are frustrating to a lot of people because of the usefulness of having a simple example you can learn from or even snag and use in your own code.

That's why we have work ongoing to not only place examples at the tops of pages, but to make the examples interactive so you can make changes to the code right on the page. There's some info about it here: https://discourse.mozilla.org/t/interactive-editors-in-beta/....

I'm glad you approve of our use of to correctly label inputs. We are not yet 100% consistent about this, but we're on the job!

Re: Documenting the Web together

#194
post #182
post #175

Earlier quoted context omitted.

Oh wow, I disagree with this quite strongly. I find they lack useful examples, and it's ridiculously hard to find even the list of methods.

What even does "the list of methods" mean? Do you mean the builtins? Those are at the docs for built in functions.[1] Or do you mean the list of all functions? Because that doesn't exist for the very good reason that it doesn't make sense to have a list like that for python. There's the module index[2] though which lists every available module, linking to their docs which list all the available functions in those mod…

Yes, I realize I can use help. Does it being available in one place mean that it shouldn't be available in others? If I'm in an IDE I don't always have the command prompt in front of me, and that should be fine!

So here's the standard library page for Python lists: https://docs.python.org/3/library/stdtypes.html#sequence-typ...

As a new python programmer, how am I supposed to know that the comprehensive API docs are actually in the tutorial? https://docs.python.org/3.1/tutorial/datastructures.html

Compare that to Javadocs (something Java got right!): https://docs.oracle.com/javase/8/docs/api/java/util/List.htm..., and .NET is similar. Ruby is also ok in this regard: https://ruby-doc.org/core-2.2.0/Array.html

(Javascript is a mess of course!)

Re: Documenting the Web together

#195

Earlier quoted context omitted.

Because video-games is still the one place where Mac and Linux are lagging behind, and they have DirectX to thank a lot for that.

Nonsense, any of such APIs are abstracted away in most game engines, and cover only a tiny fraction of a game engine codebase.

You sound like engine developers just produce those abstractions out of thin air and they work perfectly out of the box. They need to work on them and waste their time on duplicating efforts. Bugs that plague Unreal Engine for instance demonstrate how far from trivial this is.

Re: Documenting the Web together

#196
post #10

This is a great start. Now let's integrate caniuse into every single MDN page.

MDN already has compatibility tables for lots of things; if they're missing from a particular article, it's not because they're unsupported, it's because nobody has done the research and filled in the information (it's a wiki! You can add things!).

MDN didn't do a good job of advertising itself as a wiki. It wasn't until recently that you could login with a GitHub account.

When you google "can i use flexbox", caniuse.com comes up but MDN does not.

The other thing missing from MDN, is that caniuse.com shows browser support as a percentage. Now I know I'm safe to use flexbox since its supported by 97.74% of browsers in the wild.

When a new feature comes out, I add it to both MDN and caniuse. It would be great if these two could be integrated as well.

Re: Documenting the Web together

#197
post #90

Why Samsung?

Probably a case of having engulfed the industry so much that just throwing money into the industry will actually pay out for them in the long run. And it's probably also just nice to be able to bite Google and Microsoft in the butt here. Those do benefit from a healthy web and both very much need the PR of supporting webstandards, but they could also both benefit a lot more from controlling a platform like MDN and th…

From what I've heard, Samsung Internet Browser is trying to lead the way with WebVR (Virtual Reality).

https://webvr.rocks/samsung_internet

Re: Documenting the Web together

#198

Earlier quoted context omitted.

What makes it a vanity domain? Just imagine how much printed material has circulated since the 90s with the mdn.com address. Why do you want to break the web?

For JS developers, there is already a short-hand URL, mdn.io. It's quite neat in its functionality, allowing for searches via url params, like so: mdn.io/promise

thanks for that. didn't realize that mdn.io existed.

Re: Documenting the Web together

#199
post #99

mdn.com is of course a 90s directory site for Muslims in Dearborn, Michigan. last updated by the looks of it in early 2016... maybe they'll relinquish the vanity domain?

What makes it a vanity domain? Just imagine how much printed material has circulated since the 90s with the mdn.com address. Why do you want to break the web?

It's a vanity url because it's small and can be used by tons of different orgs. Not sure why we're suddenly so sad about losing some tiny corner of the web that is very unlikely to have a huge effect irl.

I used to bookmark things judiciously 7-8 years ago, that bookmarks list is completely useless today because >90% of the links are dead, that's okay though, it's the way things go. Happens with real-world objects too, books go out of print, buildings get knocked down, not everything needs to be saved.

Re: Documenting the Web together

#200
post #176

Don't forget you can use https://devdocs.io/ too which also searches MDN and store offline. The two are a great pair.

There is also mdn.io which can be used as shortcut in every browser like this (for a search for 'await'): http://mdn.io/await

If you set up your browser's default search engine as DuckDuckGo, this works from the location bar (at least in Firefox):

    !mdn await
This will perform a query to DuckDuckGo (the non-tracking search engine) first, and automatically redirect to MDN.

No need for extra add-ons; this is one of the standard set of 'bangs' DuckDuckGo provides.

Post reply on HN