Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Uniformity of formatting and style across Handbooks (iterative list) #230

Open
6 tasks
OscarSiba opened this issue Nov 13, 2024 · 1 comment
Open
6 tasks
Assignees
Labels
later Return to this after launch

Comments

@OscarSiba
Copy link

OscarSiba commented Nov 13, 2024


  • Ensure that section titling and sequence of sections is the same across all Handbooks. Currently there is some slight variation, e.g. "Ethepad" on one, "Collaborative Notetaking" on another, etc. Ideally should all say the latter, because often the sections also refer to CodiMD). "Topixbox" vs "Mailing Lists". Check this for ALL headings/subheadings and settle on one to be used per section for all Handbooks.
  • Ensure that bullet vs numbering (and sub-bulleting) conventions are used the same across all Handbooks. A lot of variation at the moment that cannot be addressed at this stage.
  • Ensure that the listing of duties of Officers (e.g., Chair and Secretary) are presented in the same way on all Handbooks. Some Handbooks list all duties under the role; others list the duties and indicate which officer is responsible.
  • Ensure that bolding and italicising conventions, especially for subheading purposes, are used in the same way across all Handbooks (rather than consistently the same in each Handbook).
  • In some Handbooks there is a lot of content overlap with the website (e.g., the Workshops and Instructor FAQ on website and content in the Handbook) - will need to carefully compare these to see if there is any need to cut out of the website to avoid repetition. Or link across.
  • How do we want emails to render: to be shown in full as hyperlinked email addresses (e.g. workshops@ communiity@) or to hyperlink the team's name that should be contacted?
  • [ ]

@OscarSiba OscarSiba added the later Return to this after launch label Nov 13, 2024
@OscarSiba OscarSiba self-assigned this Nov 13, 2024
@maneesha
Copy link
Collaborator

maneesha commented Dec 4, 2024

Thanks for getting this started @OscarSiba - this is a great list of things to review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
later Return to this after launch
Projects
None yet
Development

No branches or pull requests

2 participants