Durisian opened a can of worms and followed through and ate them all like they were gummi worms. Thus, this wiki redesign was born.
The top of this page is a spot to talk about the new wiki layout. When it's all done (other than this page) we can clean this page up as the final step, then redirect the old home page to the new one. Here goes:

Follow the Template!!

Don't call anything “new”. It'll be old soon ;)

Don't touch the old stuff…except for one thing: Mark the top of the page with some text so that we know you're already working on that page.

Remove everything that's duplicated or outdated…If you remove outdated stuff, replace it with new info, and put a pointer to the old info there, so that if people find old info, they'll know to ignore it when they read your page.

When you remove a page, follow backlinks so that you can update links to your replacement doco.

Search the forum for corroborating info. You don't wanna put the wrong info on there and get egg on your face when someone screws up because of your words Smiley

If you find one little bit of mess, chances are there are related messes that should be cleaned at the same time. Search for similar pages to the one you're working on, and follow links from it.

Dont use the H1 header style only for the title of the page, the page name will serve as the title. Use the headers for sectioning out the document so it gets a menu automatically.

D said: - not sure about this, lay down the law and scare people away, or have to clean it up on a regualr basis…

stryd says: lay down the law a little, but let it be somewhat dynamic. I've put some guidelines here for us, I guess some of them could stay on this page later on…

space things out well, it makes it easier to read

Add stuff here if you think of anything

What follows is the proper content that will be left on this page when the overhaul is done:

• project
  • controller
    • project name if required
  • sequencer
    • project name if required
  • synthesizer
    • project name if required
  • misc
    • project name if required

• mbhp
• module
• pic
• stm32
• mios
• mios32
• svn
• community
• bulk_order
• wikify
• template

Documenting your project

Project Template

Documenting your module

Module Template