Publish a product update

A product update is a dated release note. It appears on the public changelog for one product. Readers subscribe to it, and Ask AI answers questions from it.

You do not need to know Markdown. The editor has a toolbar for formatting.

Before you start

You need an administrator account. Administrator access is granted in the HANK console, not in this application. See Get access at the end of this guide.

Administrator access is currently all or nothing. A grant gives you every product, not one. Write carefully, and publish only the entries that you own.

Step 1. Open the changelog page

Sign in to https://newdocs.hank.ai.
Open https://newdocs.hank.ai/admin. The dashboard opens.
Select Changelog in the sidebar, under CONTENT.

The page has two parts. The form at the top writes an entry. The table below lists every entry.

Step 2. Find the entries for your product

The table holds the entries for every product. Narrow it before you read it.

Select your product in Filter by product.
Select Apply filters.

The table now shows only that product. The address bar keeps the filter, so you can bookmark the view or send it to a colleague. To find one entry, type a word from its title, its version, or its body in the Search box, then select Apply filters. The search also matches the product name.

Step 3. Complete the form

Each field has one job. The table below lists every field on the form.

Field	What to put in it
Product	The product that the update applies to.
Entry date	The date of the release.
Version	The release version, for example `1.4.0`.
Title	One short line that says what shipped.
Tags	Optional labels, separated by commas, for example `feature, fix`.
Work lifecycle	Select Released for shipped work. Select Fix merged when production does not have the change yet.
Change kind	What kind of change this is. Select Fix when output was wrong and is now correct. Select New for a capability that did not exist. Select Breaking when a consumer must change something. Select Notice for information only. The default is Improvement.
Customer ticket	Optional. The ticket that caused the change.
Released at (UTC)	Optional. The moment the change actually went out. Leave it empty for work that has not shipped.
Effective from (UTC)	Optional. Work processed after this moment carries the change. Leave it empty if the change applies to everything.
Publish state	Select Publish now to go live. Select Save as draft to stage it.
Body	The release note itself.

The product, the date, and the version identify the entry

These three fields together name the entry.

Save an entry with the same product, the same date, and the same version, and you EDIT that entry. You do not create a second one.

Change any one of the three values, and you create a NEW entry. Check the three fields before you save.

What a second save changes on an entry that exists

This form does not read the entry back. Every control shows its own default value, not the value you saved before. A second save therefore writes only the fields you can see that you typed.

Field	What a second save does
Title, Tags, Body	The form writes what you typed.
Change kind, Work lifecycle, Customer ticket, Released at, Effective from	The form KEEPS the stored value. It does not write the default you see.
Publish state	The form keeps the stored value. A second save does not publish a draft.
Readers	The form keeps the stored value. Use Hide from readers or Show to readers on the row.

To change a field in the last three rows, select Edit on the entry row. The Edit form reads the entry first, so each control shows the stored value. Then change the field and save.

To publish an entry that you staged before, always use Edit. A second save from this form keeps the entry staged.

The toolbar sits above the body box. Select text, then select a button to format it.

Button	What it does
Bold	Makes the selected words bold.
Italic	Makes the selected words italic.
Inline code	Shows the selected words in a code font.
Heading	Makes the current line a heading.
Bulleted list	Puts a bullet on each selected line.
Numbered list	Numbers each selected line.
Callout	Puts the selected text in a highlighted box.
Insert link	Opens a picker. Select a published page to link to it.
Insert image	Opens a picker. Select an uploaded image to place it.

Select a button with no text selected, and the editor inserts an example word and selects it. Type to replace that word.

The toolbar is one stop for the keyboard. Press Tab to reach it, then use the arrow keys to move between the buttons.

The link picker offers only published pages. The image picker offers only uploaded images, and it brings the alt text with each one. Neither picker can make a broken reference.

Step 5. Read the preview

The preview below the body shows the entry as a reader sees it. The platform builds the preview with the same renderer that builds the public page. What you see in the preview is what you ship.

The preview shows an error if the body has a mistake in it, for example an unclosed box. Correct the body until the preview renders.

Step 6. Publish

Select Save entry.

The platform checks the entry before it writes anything. It refuses an entry that does not build, an image that has no alt text, a link that does not resolve, and text that looks like patient or personal data. A refusal shows a message on the field, and it writes no entry.

A clean entry goes live at once. There is no review queue for a release note. The public changelog, the search index, and Ask AI all show the new entry within seconds.

Correct a mistake

You have three ways to correct an entry, and each one has a different result.

To change the words. Select Edit on the row. The form fills with that entry. Change what you need, then select Update entry. The public page updates. Use Edit for any field, and always use it for the change kind, the work lifecycle, the ticket, and the two dates.

To take the entry away from readers. Select Hide from readers on the row. The entry leaves the public changelog, the search index, and Ask AI at once. The entry stays in the admin table, and the Readers column shows its state. Select Show to readers to put it back.

To remove the entry completely. Select Delete on the row, then confirm. This also removes the entry from the search index. You cannot undo a delete from this page.

Prefer Hide from readers to Delete. A hidden entry keeps its history, and you can put it back in one step.

What the Readers column tells you

State	What it means
Live	Readers can see the entry.
Draft	You staged the entry. Readers have never seen it.
Internal only	The entry is published, but only administrators can see it.
Draft, internal only	The entry is staged and administrators only.

Publish from Claude Code instead

You can publish the same entry from your own Claude Code session. See the Connect Claude Code guide.

Get access

Administrator access is granted in the HANK console at https://console.hank.ai.

Ask the person who administers your organization in the console to turn on the administrator permission for your account. Tell them that you need it for the HANK documentation site.

Sign out and sign in again after the grant. The application reads your permission at sign-in.

Loading the walkthrough…