Skip to content

Wiki and documentation

Jump to bottom Edit New page
datamuc edited this page Oct 12, 2010 · 3 revisions

Wiki and documentation

The Mojolicious wiki has found its home at the github wiki next to the source code of Mojolicious. This wiki is pretty basic and every github member can edit the pages. Whenever you want to contribute documentation, correct mistakes or want to work on the wiki feel free. However, here are a few basic rules.

  • The wiki is intended to hold more information like tutorials, examples and guides than the POD documentation for Mojolicious.

  • The wiki is very flexible with information keeping and can be updated easily. A documentation change inside the Mojolicious documentation will always lead to a pull request. Keep quickly changing information to the wiki, keep the more static things to the Mojolicious docs.

  • The documentation format for the wiki pages should be set to POD. This allows the users to git clone the wiki pages for offline reading using perldoc

  • Documentation in other formats is fine, however, it might be converted to POD later.

  • Be nice and have fun.

Add a custom footer
Add a custom sidebar
Clone this wiki locally