-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
README content for modules - work in M2 Code #4451
Comments
Hi guys, can I have this assigned to me please? |
@diazwatson, assigned to you. It looks like we still need to provide you with a README template before you can start work. @dshevtsov, is there a template available? |
Yes please. |
Yes, that's correct @diazwatson. |
@jeff-matthews, the template is in our internal wiki and has to be published. |
@diazwatson, I attached the template to this comment. GitHub won't accept a Markdown (.md) file attachment, so I changed it to |
Thanks for sorting that @jeff-matthews I think I have everything to start |
No problem! Thanks for volunteering to work on this. I also created a public gist of the template: https://gist.github.com/magento-docbot/dfb8cc7db6519da14fc92b890d49b7d3 |
Make sure any links that point to devdocs contain the proper version in the URL. The template shows links with "2.1". |
Thanks for pointing that out @keharper. I just fixed the gist, but the file attached to my previous comment still has the old 2.1 links. |
Seemed like an unintentional closure via a closing keyword. |
Topic clarification/correction request
Topic Link
All modules documented in the Open Source and Commerce
of the Module Reference Guide pull the content from the READMEs in Magento 2 code. To add content, create PRs to Magento 2 core!
Solution
We need Modules documented in the Magento 2 source code.
2.4: https://github.com/magento/magento2/tree/2.4-develop/app/code/Magento
The text was updated successfully, but these errors were encountered: