Skip to content

Developer Guide

Tian Xiao edited this page Jun 23, 2022 · 4 revisions

Here are a few things to note during development.

Issues

The following labels shall be used when GitHub Issues are raised:

Label Use Case
feature To be used when new sections are created.
bug To be used when bugs are solved (e.g. broken links, spelling error, image not showing, etc.).
documentation To be used when contents are updated or new pages are added to an existing section.
ui To be used when UI is improved.

Images

Besides normal viewport-sized images, we have the following types of special images:

  • icon: Use {: .icon } selector.
  • thumbnail: Use '{: .thumbnail }` selector.

Tables

Besides normal auto-sized tables, we have the following types of special tables:

  • table-about: Use {: .table-about } selector. Used in About @snoidetx page to facilitate logos and timelines.
  • table-profile: Use {: .table-profile } selector. Used in About @snoidetx page to make contact card.
  • table-resource: Use {: .table-resource } selector. Used in Resource page to facilitate resource viewing.
Clone this wiki locally