Skip to content

Change log #68

@QuackieMackie

Description

@QuackieMackie

I'd like to see a change log area
It would take a bit of work, for each update but essentially we'd have a detailed update log of each version change.

I'm aware of this already exisitng on the Xenforo forum, but it makes sense to have it in the dev docs as well.
It would basically be a formated copy of this https://xenforo.com/community/threads/whats-new-for-developers-in-xenforo-2-3.217692/#post-1655757

The folder structure could look something like this

docs/
└── changelog/
    ├── changelog_overview.md
    ├── 2.3.0/
    │   ├── 2.3.1.md
    │   ├── 2.3.2.md
    │   └── 2.3.3.md
    └── 2.2.0/
        ├── 2.2.1.md
        ├── 2.2.2.md
        └── 2.2.3.md

changelog_overview.md would be a list of each change log file, as well as details about each version, such as date of release, a view link, and what type of update it is.

Each version md would contain a organised list of each change that would affect developers. With this organised into categories such as

  • Template Syntax
  • Javascript Methods
  • PHP / Backend
  • Admin / UI
  • Dependancy Changes
  • etc

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions