Skip to content

Latest commit

 

History

History
145 lines (121 loc) · 4.19 KB

TODO.md

File metadata and controls

145 lines (121 loc) · 4.19 KB

TODO for CCSL WeBWorK Documentation Site

TODO.md

Dates

Check the date authored in the pages metadata.

  • index.md Perhaps this is different enough to be considered as new
  • news.md Original date can be 2009-02-01 (to confirm)
  • quotes.md
  • students/index.md
  • students/WWstudenttips.md written?? Substantially re-formatted March, 2022.
  • students/WWcannotlogin.md
  • instructors/
    • index.md
    • WWcreateset.md
    • WWimport-classlist.md (not written yet)
  • authors/
    • authors.md
      • move to index.md for consistency (or move the others)
        • Others were moved for now.
      • metadata
    • mkdocs.md
    • mkdocs-vs-pelican.md
  • Add tags to pages

Authors

  • Put page authors into page metadata.

The authors are put into the html header, so the names should be complete.
Nope, the author in the html head is the site author from mkdocs.yml

In the yaml metadata header:

authors:
    - Malcolm Harper

or

authors:
    - Malcolm Harper
    - Michèle Titcombe

Page content

  • students/WWstudenttips.md
    • cleanup copyright notice
    • do we want to split into multiple pages?
    • keep or lose the toc
  • Move 2.17 notice to Announcement bar from landing page
    • link into news page for further information
    • move news page to about section from landing page section
    • hardcoded text colour into <a> for now, see if this starts working eventually
  • Move quotes to about section
  • Write about page
    • started 2022-09-19
  • Bring ww-author-tips-gotchas.md in from current staging branch
  • Add Svetla to contacts on index.md
    • and in champlain_site_info.txt
  • Add new landing site to news
    • about/about-news.md
    • overrides/main.html
  • Rewrite instructors/ins-create-set.md
  • Add page content from WW Flash Talks Ped Day 2022-11-17
    • Rémi's Randomization - author-tips-randomization.md
      • Permision
      • Page
      • Review
    • Peter's New seed for quizzes - ins-quiz-tips.md
      • Permision
      • Page
      • Review
    • Michèle Custom math achievements - ins-math-achievements.md
      • Permision
      • Page
      • Review
    • Malcolm's MathQuill - tips and tricks - student-mathquill.md and ins-mathquill.md
      • Page
      • Review

Decisions

  • Copyright for the docs:
    • cc by-sa for now
    • gnu free documentation lic or
    • all rights reserved or
  • Naming convention for pages
    • WWcreateset.md vs ww-create-set.md
    • use ww-create-set.md
  • <topic>/index.md or <topic>/<topic>.md
    • <topic>/<topic>.md
  • Directory links or not (see MkDocs docs and material??)
  • Standardize icons for instructions: radio button, button choice, check box, etc
    • and document them in the repo wiki

New Content

  • MathQuill
  • Achievements glitch
  • Bad links in imported assignments
  • Submitting to the CPL
  • Import a WW classlist
    • uncomment in nav
  • Authoring notes for this documentation site
    • write these in GH repo wiki
  • Write README that tells how to develop for this site.

MkDocs

  • Custom 404 page
  • WeBWorK icon
  • WW favicon
  • Configuration options at MkDocs
  • and Material for MkDocs
  • How to syntax highlight pg code
    • For now, how to alias pg as perl
  • Set up tags in config
  • Set up tags index
  • Configure search options (material options are different from MkDocs)

Branding

  • Colours to match Champlain colours

Project