Editing General Web Design Guide

{{Template:DevPortal|this page outlines general recommendations and does not require strict adherence}}

==General Structure==

This page is set as a general guideline for consistency across our web development. This article does not cover in depth; [[Server Side Scripting]],
[[Image Formatting]] or other more advanced web design, however it serves as a suitable base for those project types.

===Assets===

For a normal project, you should expect to have the following assets:
* HTML files
** ex. index.html
* CSS files
** ex. styles.css
* JavaScript Files
** ex. main.js
* Image Files
** ex. logo.png, photo.jpg
* Meta Data Files
** ex. web manifest, favicon.ico, robots.txt

===Directory Structure ===

The root directory of your project (your project folder) will be listed as <span style="color:#F00">root/</span></br></br>

The main HTML file of your project should always be called <span style="color:#F00">root/</span><span style="color:#0F0;">index.html</span>
</br>Web servers will automatically display this file, when accessing the root directory in a browser

</br></br>
Your main CSS file (stylesheet) should always be called <span style="color:#F00">root/</span><span style="color:#00F">styles/</span><span style="color:#0F0;">styles.css</span></br></br>

The main style must be imported in the HTML file, more on this further in the article</br></br>

The main JavaScript file should always be called <span style="color:#F00">root/</span><span style="color:#00F">scripts/</span><span style="color:#0F0;">main.js</span></br></br>

Image files should always be placed in <span style="color:#F00">root/</span><span style="color:#00F">images/</span></br></br>

Meta Data files (such as favicons, robots.txt, APIs for search engines, etc..) should always be placed in <span style="color:#F00">root/</span></br></br>

Note that APIs should almost always be imported into <span style="color:#0F0;">index.html</span> as a CDN</br></br>
<!-- Note to self: link CDN article here -->

The name of the root directory should be formatted as such:</br>
<<b>site name</b>>_<<b>date stamp</b>>_<<b>release type</b>><span style="color:#0F0">.zip</span></br></br>

Dates are formatted: <b>mmddyyyy</b>

====Release Types====

* <b>bleeding</b> - fresh off the grill, most recent code push, not thoroughly tested
* <b>release</b> - fully ready, tested and deployed
* <b>indev</b> - incomplete code, missing several features
* <b>patch</b> - meant to be extracted to the root directory to fix a bug/add a feature
* <b>depreciated</b> - outdated and out of use, kept around for archival and development purposes

==HTML==

==Recommended Software==


===General Template===

==CSS==

==JAVASCRIPT==