Contributing to the Wiki

Matthew Taylor edited this page May 23, 2016 · 17 revisions
Clone this wiki locally

Thanks for helping us populate this wiki with useful information about NuPIC! This wiki is editable by anyone with a Github account. Before you change anything, here are a few tips about the structure of the wiki itself.

Help Wanted Markers

The following markers are located within wiki pages that need additional content:

Help wanted! This section needs some work. Would you like to help us keep it relevant?

If you see one, consider it an invitation to jump in and try to provide that content. We welcome your wiki contributions!

Markdown

This wiki uses Github-Flavored Markdown. Please make sure your edits are properly formatted and display nicely.

Making offline changes

If you are making major changes, you might want to take this work offline and push it all at once. Luckily, this wiki is powered by git and gollum, so offline editing is easy. You can read about how to do it here. There are some things you can only do when offline, like adding images, sidebars, headers, and footers.

The Home Page

This is the first page users will see when they come to the wiki, so it needs to be simple, clear, concise, and pleasing to the eye. Because of these reasons, it is heavily moderated. Please don't make changes to this page unless you have approval from someone who has recently edited the page.

Creating New Pages

If you find a topic missing from the wiki, please feel free to create a new page. But before you do, search the current wiki to ensure a similar page doesn't already exist. It might be easier for you to update existing content instead of creating new content.

If you think you've created something useful for others, point it out on the NuPIC Forum. Others in the community might enjoy your contributions, or even help populate it.

Editing Existing Pages

If you find a typo or grammatical error on any page, please fix it! If you are making considerable changes (especially deletions!), you might want to take your change suggestion to the NuPIC Forum first. Page history is kept forever, so if someone doesn't like your changes, it's easy for them to revert them.

Don't get into an editing war with someone! If you find yourself going back and forth making incompatible changes with another wiki author, please contact them and discuss the issue offline before deciding how to proceed. If you need more community involvement, make your plea to the NuPIC Forum.

Keeping the Wiki Clean

Because our wiki is publicly editable, it can expand quickly without being kept in check. We want all the most important pages to be within a few clicks of the Home page. So we've added this Wiki Administration page that keeps tabs on pages that should be deleted, orphans, and historical pages that we want to keep around.

Editing the Sidebar

The Sidebar is the block of links on the right side of the page. This is another heavily-moderated wiki page, so think before you edit it. You can edit it here.