Add the ability to register documentation changes (Changelog)

[Ibochkarev]

What needs to be improved?

It is necessary to add the ability to register changes in the documentation. Keep a list of changes - since the documentation will be updated, new sections are added, some of the content is deleted for various reasons. It is important that the original source (English version) - recorded changes.

Suggestions:

• Changelog - after pouring into the repository
• Mark visually in the documentation using a special tag:

[! NOTE]
This is a NOTE

[! WARNING]
This is a WARNING

[! TIP]
This is a TIP

[! IMPORTANT]
This is IMPORTANT

This will allow:

• see what is not translated, updated
• maintain the relevance of the documentation based on the experience and knowledge of colleagues

Relevant versions

The problem affects the following version(s):

• 2.x (current)
• 3.x

[christianseel]

Would it be possible to use the git history here? I guess writing a separated changelog is too much work.

[Ibochkarev]

@christianseel It is possible to make the rule of the name PR:

• Add page - [Add] - page name
• Add translate - [Translate] - page name
• Update - [Update] - page name
• Deletion of outdated information - [Outdated] - page name
• And so on...

[Ibochkarev]

Splitting this issue into two layers:

1. Visual tags ([!NOTE] / WARNING / TIP / IMPORTANT) — DocsApp rendering. Opened PR: Bump nanoid from 3.3.4 to 3.3.18 in /public/template DocsApp#401 (also tracks DocsApp Issue on extending-modx/creating-components/package-build #353).
2. Docs changelog list — better as git history / PR titles than a hand-maintained file (as @christianseel noted). DocsApp already indexes per-page history for the contributors block. A site-wide “what changed in the docs” page would be a separate DocsApp feature (or a curated page in the Docs repo).

Suggest keeping this issue for the changelog/process piece, and treating callouts as done once the DocsApp PR merges.

[Ibochkarev]

Correction: DocsApp PR is modxorg/DocsApp#404 (not 401).