Replies: 2 comments 2 replies
-
Thanks for opening this and creating the list @teoli2003 - is it ok if I create a project issue and add it to our roadmap? |
Beta Was this translation helpful? Give feedback.
2 replies
-
Let's track our progress: In January 2024, we did 7.53% of the work needed! 😄 26 pages of the missing 345 have been added to MDN. Well done! 🎉 Thank you to @skyclouds2001, @ShubhamOulkar, and @OnkarRuikar for their work. ❤️ |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
In 2024, we would like to document all members (properties, methods) of HTML interfaces (like
HTMLLegendElement
orHTMLInputElement
) that are working in every (modern) browser. In other words, we would like one separate reference page for each interoperable HTML feature.We are looking for help! Thank you in advance!
Context
MDN Web Docs aims to document every Web platform interface, property, and method. We added thousands of pages over the years and would like to complete our reference documentation of HTML DOM, especially features supported by every browser.
To achieve this, we want to add the 344 missing pages, which is a lot of work. This is why we are looking for help. If you like to write and have some understanding of JavaScript and HTML, we are looking for you!
How to help
Create a missing page, following our standard, and we'll review it. The list of missing pages is available in this Google docs. Select one and add your name next to it to assign it to you:
To create a missing page, create a new page (locally or using the GitHub UI) with the right name, follow the associated template, and listen to the additional instructions from reviewers. Feel free to ask questions here or even in your draft PR:
Tips
You can't break anything, and we are here to help.
Start with one page; there will be comments, and you will learn much from it. Later, you'll be able to create several related pages simultaneously, but don't create too large PRs: they take much longer to review.
MDN Web docs have many reference pages already written: look how they have been written; we are looking for consistency between pages. Typically, you can adapt the structure of an existing similar page. Even if most pages follow the template, some pages differ from it as they are older: the template stays the reference.
The example must be short but have the necessary context. Where possible, write a live sample. See the documentation about how to do it.
We have linters adding comments: please fix them (or call for help if you don't understand them). There is also a special comment added to a PR with links to a preview of the page; it also lists flaws that you need to fix. A new page should have 0 flaws. Again, if you are unsure you understand a flaw, feel free to state it in the PR so we can provide assistance.
Conclusion
This work will allow us to help many beginner developers by providing additional information about these basic features and examples for each.
I would like to thank all of you for your help already.
Quicklinks to the organizational Google docs.
Beta Was this translation helpful? Give feedback.
All reactions