MDN on GitHub

MDN documentation has now been fully migrated to GitHub! This is a major improvement that has been planned for a long time. Chris Mills explained:

We will use GitHub's collaboration tools and features to migrate MDN from Wiki mode to Pull Request (PR) mode. This is much better for contributors, allowing for smart code checking, batch editing, and including MDN documents in any workflow you want to add (you can edit the MDN source files directly in your favorite code editor).

This migration involves a brand new backend and front-end architecture.

For example, if you want to update the article for :focus-within , there will be a button on the page that takes you to the corresponding file in the repository (rather than the Wiki editing page), you can edit it directly in the GitHub interface (or use the Git way you are used to, but the GitHub interface will seem to be the main editing place). Saving the changed document will automatically create a Pull Request, and then there will be a dedicated team to review it.

We expect your changes to be available within 48 hours at the latest.

I think this is a wise move. Although I don't understand the specific technical details, the content model is designed very cleverly. I personally may prefer to see content using Markdown format, reduce some special class names, etc., but this can be gradually improved over time, and it is already amazing to complete such a large-scale update at one time.

In August 2020, the entire MDN (writer) team was laid off, so the move seems to be aimed at opening up the creation and editing of these technical documents to developers around the world. Will it succeed? The attempt at "Web Platform Docs" (remember?) was very failed. But MDN has more existing content, higher visibility and stronger momentum. I expect it will be very effective in maintaining existing documents, and it is also quite good in handling latest technical documents, but may be less effective in handling old, "boring" content.

It seems a bit risky to fire all writers before confirming their validity, reflecting a shift in product direction. The situation is changing and it seems that paying directly to the content creation team is no longer part of the new direction of development.

The above is the detailed content of MDN on GitHub. For more information, please follow other related articles on the PHP Chinese website!