Skip to content

Commit

Permalink
Improve spec wording since it apparently went live
Browse files Browse the repository at this point in the history
  • Loading branch information
hftf committed Aug 14, 2024
1 parent 0407367 commit 5f3c302
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions SPEC.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# Spec
This page documents the plain-text data files used to generate the calendar and map pages of this website.

## Circuit map

Information about the colleges on the circuit map is stored in `map/colleges.tsv`.

## Season calendar

The layout of the main calendar pages (which contains the large tables) is defined by `_layouts/year.html`.
The layout of the main calendar pages (which contains the large tables) is generated by the template `_layouts/year.html`. It contains some hard-coded values, but generally does not need to be changed.

The order of tournaments within each part of a year (e.g. Fall or Spring) is defined by <code>\_data/sets/_‹year›_/seasons.yaml</code>.
The order of tournaments within each part of a year (e.g. Fall or Spring) is defined in <code>_data/sets/<i>‹year›</i>/seasons.yaml</code>.

Information about each set is stored in a separate YAML file in the <code>\_data/sets/_‹year›_/</code> folder. The following list of keys are supported:
Information about each set is stored in a separate YAML file in the <code>_data/sets/<i>‹year›</i>/</code> folder. The following list of keys are supported:

Key | Description | Example
-|-|-
Expand Down Expand Up @@ -70,7 +74,3 @@ AS | Asia
Mirrors should generally be ordered in the source file canonically by date (weekend) and then by region, with playtest mirrors first and HS mirrors at the end, unless there is a good reason to order them in another manner.

Mirror names (i.e. college or school names) should generally remain consistent with existing convention in this repository. A guiding principle for mirror names is to be short enough to not wrap onto two lines when displayed in the main table, but not be overly abbreviated.

## Circuit map

Information about the colleges on the circuit map is stored in `map/colleges.tsv`.

0 comments on commit 5f3c302

Please sign in to comment.