# README.md files for Ansible plugins **URL:** \ **Category:** Ansible Project\ **Created:** [January 7, 2016, 11:34pm UTC](https://forum.ansible.com/t/readme-md-files-for-ansible-plugins/20147 "2016-01-07T23:34:09Z")\ **Posts on this page:** 2\ **Page:** 1
**Author:** ![Tom\_Paine1](https://avatars.discourse-cdn.com/v4/letter/t/3da27b/32.png) [@Tom\_Paine1](https://forum.ansible.com/u/Tom_Paine1)\ **Post date:** [January 7, 2016, 11:34pm UTC](https://forum.ansible.com/t/readme-md-files-for-ansible-plugins/20147/1 "2016-01-07T23:34:09Z")
The supplied plugins, like the [callbacks](https://github.com/ansible/ansible/tree/devel/lib/ansible/plugins/callback) and [filters](https://github.com/ansible/ansible/tree/devel/lib/ansible/plugins/filter), have the potential to be a great resource. Unfortunately, they are lacking standardised documentation which makes it difficult to understand their function and/or output without studying the code - not particularly scalable once there are many submissions. The addition of a templated markdown README for complex plugins would make them much easier to browse and understand. **Would you accept PRs with READMEs for the plugins?** If so, would they move to a directory of the same name or sit in the same directory (side-by-side like the inventory scripts and associated .ini files). ---
**Author:** ![Brian\_Coca](https://avatars.discourse-cdn.com/v4/letter/b/6de8d8/32.png) [@Brian\_Coca](https://forum.ansible.com/u/Brian_Coca)\ **Post date:** [January 7, 2016, 11:50pm UTC](https://forum.ansible.com/t/readme-md-files-for-ansible-plugins/20147/2 "2016-01-07T23:50:28Z")
On my wishlist I have an item to generate docs for ALL plugins like we currently do for modules/task plugins, if we standardize on 'external' rst or go again for an 'in module doc' is yet to be decided. But at this point any docs are welcome.