Kate's Space

Quality Assurance

A page for ensuring that I develop this site in a manner that doesn't burn me out

Sitemap / File Structure

May become it's own page later.

Naming Conventions

Inflectional Suffixes in Folder Names

I've been on the fence for a while about making a "pages" folder because I didn't know if it should be called "page" or "pages," but I think I have a good system now:

  • If a folder can reasonably have a page that lists it's contents, then it should.
  • In the above case, use an inflectional suffix (-s or -es) so the index of that folder will be named such that it's listing a plurality of things.
  • Sorta breaking the convention established above, but I'll call the folder for resources shared between most pages "shared" so the url will be like /shared/styles/etc...

Code Conventions

Sublists

I have been doing list nesting like this for a while

<ul>
  <li>Milk</li>
  <li>Cheese</li>
  <ul>
    <li>Blue cheese</li>
    <li>Feta</li>
  </ul>
</ul>
  • Milk
  • Cheese
    • Blue cheese
    • Feta

...but this means that ul is containing a jumble of li's and ul's, which seems messy to me. I checked the Mozilla docs and they instead do:

<ul>
  <li>Milk</li>
  <li>
    Cheese
    <ul>
      <li>Blue cheese</li>
      <li>Feta</li>
    </ul>
  </li>
</ul>
  • Milk
  • Cheese
    • Blue cheese
    • Feta

...which looks the same unstyled, but keeps the ul bundled with the li immediately above it in the list, because a list within a list should be relevant to what's above it, and not a list item in itself. I have added box-shadows and colors to highlight this.

Online Tools I Should Find Local Alternatives For