> For the complete documentation index, see [llms.txt](https://docs.e6data.com/query-engine/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.e6data.com/query-engine/reference/platform-reference/release-notes-format.md).

# Release notes format

What each section of an e6data release note covers, so you can scan releases efficiently.

Each release note in the [Changelog](/query-engine/changelog/changelog.md) follows a consistent structure. This page describes what each section means.

## Sections

### Release header

The release version, date, and components affected.

```
Release 1.2.3 - May 13, 2026
Components: Platform Components, Metadata Service
```

### Highlights

The 2–4 most user-visible changes in the release. Scan this first.

### New features

User-facing capability additions. Each entry links to the relevant doc page.

### Improvements

Performance, reliability, or usability improvements that don't add new surface area.

### Bug fixes

Fixed issues. Each entry references the bug ID (for example, `E6-1234`) for support reference.

### Breaking changes

Anything that changes existing behavior in a way that could affect customer queries, configurations, or integrations. Always read this section before upgrading.

### Deprecations

Features marked for removal in a future version. Lists the deprecated feature, the recommended replacement, and the planned removal date.

### Security advisories

Security-relevant fixes. Includes severity (Low / Medium / High / Critical) and whether action is required from customers.

## How to use release notes

| Scenario                       | What to read                                      |
| ------------------------------ | ------------------------------------------------- |
| Deciding whether to upgrade    | Highlights, Breaking changes, Security advisories |
| Looking for a specific fix     | Bug fixes (search by bug ID or symptom)           |
| Planning future work           | Deprecations                                      |
| Understanding new capabilities | New features, Improvements                        |

## Versioning

e6data uses semantic versioning:

| Version part        | Meaning                                                 |
| ------------------- | ------------------------------------------------------- |
| **Major** (`X.0.0`) | Breaking changes possible; read release notes carefully |
| **Minor** (`1.X.0`) | New features; backward compatible                       |
| **Patch** (`1.2.X`) | Bug fixes and security updates; backward compatible     |

Major version bumps are rare (typically annually). Most releases are minor or patch.

## See also

* [Changelog](/query-engine/changelog/changelog.md)
* [Version upgrades](/query-engine/reference/platform-reference/version-upgrades.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.e6data.com/query-engine/reference/platform-reference/release-notes-format.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.