Contributing to allergyguide.ca

Thanks for checking us out! If you're interested in clinical allergy and immunology and would like to help out, connect with us (see the mail button at the bottom of the page). We are interested in recruiting medical students, residents, and allergy-immunology staff.

Contribution process

After exploring what options exist on the contribution hub:

The contribution process follows this rough timeline:

Stylistic Principles

General writing guidelines

• Be concise and clear -- the intended use is for residents
• Use clear, structured formatting (headings, bullet points, tables) for readability
• Avoid passive voice where possible
• Abbreviations are fine but must be defined
• While a single topic might be quite complex (i.e. asthma), each page is still meant to be relatively simple -- the goal is not to be a comprehensive textbook. Link to a resource that goes more in depth at that juncture, to another subpage, or create a drop-down 'Deep-dive'

General formatting guidelines

• Bullet points: Prefer over long paragraphs; no periods at the end of items
• Emphasize key points: Use bold, colour, and highlights
• Tables/Figures: Only if they enhance understanding (e.g., decision algorithms)

Website / coding

• If you have experience with programming (reasonably comfortable with Markdown, html, js, scss/css, and git) and want to contribute, very happy to have you on board! To learn the structure of the website, please refer to the Zola documentation. Pages are written in Markdown with Tera templating
• Josh will be the main person approving pull requests for the time being
• Re: adding content to website -- there are some formatting nuances, and a myriad of shortcodes that can be used.
• When adding images, they should all be .pngs; ideally before committing they should be compressed/optimized. Ie. with oxipng

oxipng -o 4 --strip all -a -Z *.png

ROADMAP and TODO!:

## Content

- guideline compilation section (not sure if there's a way to automate this unfortunately but will attempt)
- Allergic rhinitis seasonal calendar for allergens
- creation of video resources if time permits
- Billing tips (would have to be province specific -- VERY fellow/new staff focused)
- Running a practice tips potentially?

## Shortcodes

- Refactor references so that it accepts a .bibtex file instead
- port original pen-fast questions over with extra options; need to see if .PDF js packages are possible.

## Misc

- main staff TBD - to reach out
- other editors/contributors -- TBD but WIP
- team structure to be more well defined