Skip to content
ModernUI A DaneTrades developer library

Version Support Policy

This page explains how ModernUI versions, support, and documentation should be treated.

Versioned docs

Each documentation page includes a version field in its frontmatter.

That field means the page is relevant from that ModernUI version onward, unless a later release note says otherwise.

Compatibility goal

ModernUI aims to keep public APIs stable after release.

The main compatibility goals are:

  • do not remove working public APIs without a clear migration path
  • keep wrapper names stable
  • keep raw controls available
  • preserve existing examples where possible
  • document behaviour changes
  • document breaking changes clearly

Fast wrappers are additive

Fast wrappers are an additional creation layer.

They do not deprecate raw controls.

Code using raw controls should not need to migrate just because wrappers exist.

Supported versions

Support should focus on:

  • the current public version
  • the most recent previous public version where practical
  • documented upgrade paths for breaking changes

Very old private builds, modified local forks, or partially copied library trees may be outside normal support.

Release notes

Each public release should have a release note.

Release notes should use this structure:

Reference excerpt
Added
Changed
Fixed
Known notes
Upgrade notes

Do not use release notes to make vague roadmap promises.

Documentation maintenance rules

Docs should stay tied to product changes.

Rules:

Reference excerpt
No public API change ships without a docs update.
No new example ships without a docs page or release note.
No breaking behaviour ships without a migration note.
No renamed method ships without a compatibility note.
No screenshot stays if it no longer matches the current UI.

What support includes

Support includes:

  • installation help
  • compile help for shipped examples
  • clarification of documented APIs
  • wrapper usage questions
  • reproducible UI bugs
  • documentation corrections
  • version-specific behaviour questions

What support does not include

Support does not include:

  • writing full EAs for users
  • debugging unrelated trading logic
  • building custom strategies
  • broker execution issues unrelated to ModernUI
  • guaranteeing compatibility with modified third-party code
  • supporting partial or incorrectly copied package installs
  • converting an existing commercial EA into ModernUI as part of normal product support

Modified source

ModernUI is source-based. Users may modify it.

If you modify the library source, support may ask you to reproduce the issue on an unmodified package before treating it as a library bug.

MQL5 Market delivery note

MQL5 Market delivery may impose its own packaging and distribution constraints.

The docs remain the source of truth for usage, but the exact buyer package layout should match the product as shipped.

Keep include lines consistent with the shipped package.

Recommended update process for users

When updating ModernUI:

  1. Back up your current Include/ModernUI/ folder.
  2. Replace it with the new package version.
  3. Restart MetaEditor.
  4. Compile supplied examples first.
  5. Compile your own EA.
  6. Check release notes for upgrade notes.
  7. Test UI interaction on a chart.

Related pages