Fork me on GitHub

HumMod

Help

Documenting for the HumMod Project

This document contains how-to information for the HumMod documentation.

Back to the Main Page.

Technical Instructions

Step-by-step

  1. Fork the Documentation repository.
  2. Clone your copy of the repo: > git clone git@github.com:your-username/documentation.git
  3. Add a remote for our repository: > git remote add upstream git://github.com/HumMod/documentation.git
  4. Switch to the "gh-pages" branch: > git checkout gh- pages
  5. Create/modify documentation.
  6. When you are done, fetch and merge from our repository:
    > git fetch upstream
    > git merge upstream/gh-pages
  7. Push changes back to your repo: > git push origin gh-pages
  8. Submit a pull request back to us.

      9. Style

      All pages in documentation should be written in clean, well- structured HTML and follow our CSS. This page is an example page that has been completed under documentation and contains all the most important elements and formatting required to do HumMod documentation.

      To see its raw code, open your browser developer tools. If using Google Chrome, the shortcut is F12. If using Mozilla Firefox, the shortcut is CTRL+U. If using Internet Explorer 9, the shortcut is also F12. Alternatively, in any of these browsers you can right- click on the web page and choose "View Page Source" or s similar option.

      Please note how paragraphs, internal navigation using the < nav > element, images, and sections are formatted. Please follow these styles in all HumMod documentation in order to facilitate a clean and easily modified help section.

      If you have any questions or comments regarding stylistic concerns in HumMod documentation, please contact us.

      Structure

One of the most important elements in our documentation is that every page is divided into sections using the HTML < section > tag. These tags are enormously important and allow content to be properly catagorized and are vital for in-page navigation using HTML5's < nav > tag. Please make sure to use them and use them properly.

All sections must have a header tag with an <h1> element inside. Content goes inside the <section> tag, but outside the <header> tag.

For example: 


	
	<section id="example-section">

  	<header>

    	<h1>This is an example of a section</h1>

    	<a href="#block">Back to the top.</a>

  	</header>


  	<p>

    	Sections should be structured like this example.  Note the
 	section, header, and h1 tags.  Further, the section has an id
 	that corresponds to the sections header. This unique id is used
	for linking within the page.

  	</p>


  	<p>

   	Since we link inside the page, it's necessary to update the main
	nav group up top.

  	</p>


	</section>