README.md

Mzeis_Documentation

Manage your project and module documentation in the backend.

Facts

• Composer key: mzeis/mzeis_documentation
• Version: 1.1.0
• Extension on GitHub

Compatibility

• PHP >= 5.3
• Magento >= CE 1.9.1 (may also work in other versions)

Main Features

• General
  • Search through the documentation
• Project documentation
  • Create and maintain your e-commerce project documentation in the backend
  • Use the WYSIWYG editor for easy editing
  • Create links between pages easily (just like in a Wiki)
  • Manage permissions for viewing and editing
  • Find orphan pages
• Module documentation
  • Read the developer documentation (= markdown files) in the backend

Documentation

1. Installation
2. Uninstallation
3. General
   1. Usage
   2. Difference between project and module documentation
   3. Permissions
   4. Configuration
   5. Set another page as the documentation homepage
   6. Searching
   7. Showing all pages
4. Project documentation
   1. Editing a page
   2. Choosing the format
   3. Renaming a page
   4. Creating a new page
   5. Orphan pages
5. Module documentation
   1. Making your documentation available in the backend
   2. Ways to make your files being read
   3. Alternative: save the module documentation in the database
6. Known issues

Changelog

CHANGELOG.md

Build Status

Latest Release

Development Branch

Support

If you have any issues with this extension, please create an issue on GitHub. Please provide error messages, debug information like output from the Magento error logs and the exact steps / code to reproduce the issue.

Contribution

Any contribution is highly appreciated. The best way to contribute code is to open a pull request on GitHub. Always create pull requests against the dev branch.

A big thank you to all contributors!

Author

Matthias Zeis (matthias-zeis.com, @mzeis)

License

MIT License

Copyright

(c) 2015 Matthias Zeis