devsoc-unsw/circles

Create and Style ChangeLog Page

Opened this issue · 0 comments

(edit: olli)
Create a changelog page, as inspired by the Github Releases page.

  • Ideally, this should feature collapsible titles, each consisting of a semantic version number and a optional flair text.
  • All should be collapsed by default except the most recent
  • In each one, there will be some optional sub-sections
    • I'm currently imaging the sections "Major Changes", "Minor Changes" and "Bug Fixes"
    • each of these subsections also allow two layers of nesting dot points, so it appears like this mark down
  • the list of changes will be stored in a json file, that either you retrieve via an import or an api call (probably most definitely the former)

We have not yet thought too much about the json structure, but assume the following as an example for now:

[
  {
    "version": "3.3.1",
    "flair": "User data!!!",
    "major": [
      { "main": "bla bla bla first level dotpoint", "details": ["second level dotpoint 1", "second level dotpoint 2"] },
      { "main": "bla bla bla first level dotpoint with no second level dotpoitns" }
    ],
    "minor": [
      { "main": "bla bla bla first level dotpoint", "details": ["second level dotpoint 1", "second level dotpoint 2"] },
      { "main": "bla bla bla first level dotpoint with no second level dotpoitns" }
    ],
    "fixes": [
      { "main": "bla bla bla first level dotpoint", "details": ["second level dotpoint 1", "second level dotpoint 2"] },
      { "main": "bla bla bla first level dotpoint with no second level dotpoitns" }
    ]
  }
]

And this might turn out to look like (in html ofc and much prettier)...

3.3.1 - User data!!!

Major Changes:

  • bla bla bla first level dotpoint
    • second level dotpoint 1
    • second level dotpoint 2
  • bla bla bla first level dotpoint with no second level dotpoitns

Minor Changes:

etc...