> For the complete documentation index, see [llms.txt](https://docs.netmap.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.netmap.dev/reference/changelog.md).

# Changelog

`CHANGELOG.md` is the single source of truth for release notes and the in-app What's New modal.

The installed version comes from `/app/VERSION` when baked into the image.

## How NetMap Uses The Changelog

The changelog is used for two related purposes:

1. Human release notes.
2. In-app What's New content for the installed version.

The What's New modal is based on the installed version, not merely the newest available GitHub tag.

## Installed Version

The application reads `/app/VERSION` first. `APP_VERSION` is fallback-only when the version file is unavailable.

## Release Notes

Release automation extracts release text from `CHANGELOG.md` for version tags. Keep release notes clear, user-facing, and grouped by impact.

Good release-note sections:

* Added
* Changed
* Fixed
* Security
* Operations
* Documentation

## Documentation Expectations

Update the changelog for:

* user-visible features;
* user-visible fixes;
* security hardening;
* operational behavior changes;
* API-key or authentication changes;
* release-candidate changes.

Do not use the changelog for internal-only refactors unless they matter to users or operators.

## Related Pages

* [Upgrading](/installation/upgrading.md)
* [Operations](/operations/operations.md)
* [Developer Guide](/development/development.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.netmap.dev/reference/changelog.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.