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

Create and Style ChangeLog Page #1153

Open
pikapiku opened this issue Jun 19, 2024 · 0 comments
Open

Create and Style ChangeLog Page #1153

pikapiku opened this issue Jun 19, 2024 · 0 comments
Assignees
Labels
👤 closed for help 👥 Closed to external help, team only 📝 feature 🧠 New feature or request 🫣 331 🤫 Is only in scope within the current 331 branch

Comments

@pikapiku
Copy link

pikapiku commented Jun 19, 2024

(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...

@pikapiku pikapiku self-assigned this Jun 19, 2024
@pikapiku pikapiku added 📝 feature 🧠 New feature or request 🫣 331 🤫 Is only in scope within the current 331 branch 👤 closed for help 👥 Closed to external help, team only labels Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👤 closed for help 👥 Closed to external help, team only 📝 feature 🧠 New feature or request 🫣 331 🤫 Is only in scope within the current 331 branch
Projects
None yet
Development

No branches or pull requests

1 participant