Managing Help Articles

The Help Articles screen is where the help texts opened on console screens are written, published, and kept up to date. Each published article is used as a source in the help center, the help drawer of the linked screens, and CLAI's responses. Articles are written only in Turkish; the English version is automatically generated from the Turkish text on each save. The screen is intended for administrators with article writing permissions; other users can only read articles.

Accessing the Screen

The Help Articles screen is not listed in the menu; it can be opened via:

• The Manage articles button above the Help center page.
• The Edit button next to the title when an article is open in the help center. This opens the editing page of that article directly.
• The help drawer opened by the Help for this screen icon in the top bar of any screen (or by pressing ? when not in a text box):
  • If the screen has help, the Edit link at the bottom of the drawer opens the displayed article.
  • If the screen has no help, the Write help for this screen link below the No help has been written for this screen yet message opens a new article linked to that screen.

These buttons and links appear only for accounts with article writing permissions. If you access the page URL without permission, you will be redirected to an authorization warning page.

Screen Sections

At the top of the page are the Help articles heading, the Open help center link at the top right, and the New article button. Below are three tabs:

Articles Tab

Filtering and Searching

The number of articles matching the filters is shown on the right. Filters are saved in the page URL; sharing the URL opens the same list.

List

The most recently changed article is at the top; sorting cannot be changed.

Clicking a row opens the article's editing page. If no articles exist, No articles yet is shown; if no articles match the filters, No articles match the filters is shown.

Screen Coverage Tab

This tab shows whether each screen in the menu has publicly available help.

At the top summary card, a line like "40 / 120 screens have published help" is shown. If some screens have only drafts, a note like "Only drafts on 5 screens" appears. Checking the Only screens without published help box hides screens with published help, leaving only pending tasks. If all screens have help, Every screen has published help is shown.

Below, screens are listed in cards grouped by product. Each row shows the screen's menu name, its address below, and a coverage badge:

Row buttons:

• Open article: If there is exactly one non-archived article linked to the screen, opens it.
• Article count button (e.g., "2 articles"): If multiple articles exist, opens the Articles tab filtered to that screen. Archived articles are also listed there, so the count may differ.
• Write: Visible if the screen has no published help. Opens a new article linked to that screen.

For screens in Draft only status, Write starts a second, separate article. To publish an existing draft, open it and set its status to Published.

The list includes only screens visible in your menu. Detail pages not in the menu (e.g., an individual order page) do not appear here; you link them manually on the editing page.

Freshness Tab

An automatic weekly check compares the screens linked to each article with their state when the article was saved and records a decision on whether the article is still accurate. This tab lists the latest decision for each article.

Summary and Filter

The top card shows a badge and article count for each freshness status (e.g., "Outdated: 3"). Clicking a badge filters the list by that status; clicking again removes the filter. The same can be done with the Freshness status box above the list (All statuses clears the filter).

Archived articles are excluded from the list. Articles with no check records yet are listed only if published and linked to at least one screen; topic articles not linked to any screen and drafts do not appear until a check record exists. Rows are ordered by importance: Outdated, Needs review, Never checked, Minor change, Up to date. Within a group, the newest check is on top.

List

The expanded details show changed files (with badges changed, added, Deleted, or screen removed; the last indicates the linked screen no longer exists in the console), changed UI labels ("old → new"), and the comparison date. If you wrote a button name in bold in the article and it changed, it appears in the label list.

Each row has two buttons on the right:

• Open: Opens the article's editing page.
• Still accurate: Without changing the article, sets today's screen state as the new baseline (see below). Not visible in rows already in the Up to date group. While a verification is in progress, all Still accurate buttons are disabled; the clicked row shows Verifying….

If the weekly check has never run, a note The weekly freshness check has not run yet appears and all published articles show Never checked; this is not an error. If the list is empty, All articles are up to date is shown.

Actions

Writing a New Article

1. Click the New article button or the Write button of a screen in the Screen coverage tab.
2. Fill in the Title field. The Slug is auto-generated from the title for new articles (e.g., "Order Return Process" → siparis-iade-sureci). If you edit the slug manually, auto-generation stops.
3. Fill in Summary, Tags, and Linked screens fields (field rules below).
4. Write the article in the Body (Markdown) field; preview how it looks.
5. Select the Status. New articles start as Draft; select Published to make it visible to readers.
6. Click Save (or Ctrl+S / ⌘+S).

During saving, Saving and translating to English… appears at the top right and the form is locked; saving may take a few seconds. When done, a notification Article saved (or Article saved, English translation updated if translation was refreshed) appears, the page navigates to the article's own URL, and the panels below become visible.

Editing an Existing Article

1. Click a row in the Articles list (or Edit in the help drawer or help center).
2. Change fields. When you make changes, an Unsaved changes badge appears at the top right.
3. Click Save.

If you try to leave the console page with unsaved changes, a confirmation asks Unsaved changes will be lost. Leave the page?; closing the tab or refreshing shows the browser's own warning. If the article is published, you can open the reader view via the View in help center link at the top right.

Marking as Verified by Comparing with Screen

When you are sure the article matches the screen, before saving, check the Checked against the screen, text is up to date box. Saving sets the verification date to today and updates the Verified column in the list. Below the box, the last verification date or Never verified is shown. The box clears automatically after saving.

Still Accurate (Dismiss Freshness Warning)

If the check marked an article as Needs review or Outdated but the article is still correct:

1. Click the Still accurate button in the Freshness tab row or the Still accurate — take today's code button in the Freshness panel on the editing page. No confirmation is asked; the action is immediate.
2. A notification Article verified; today's code is the new baseline appears. The article's decision becomes Baseline taken and the row moves to the Up to date group.

This action does not save the article text; it only updates the baseline for the next weekly check. If you have unsaved changes, the panel reminds you; save your text with Save. Each save also updates the baseline; if you corrected and saved the article, you do not need to click Still accurate.

If you see the warning This build has no code manifest, verification cannot be done currently; the article is unchanged, try again later.

Reverting to an Older Revision

1. Click a record in the Revisions panel. Each row shows the save date, user, character count, and status of that revision.
2. Review the title, status, summary, and body in the opened Revision preview window.
3. Click Restore into editor. The title, summary, tags, linked screens, and body load into the form; a notification Revision loaded into the editor — remember to save appears.
4. Click Save.

Restoring into the editor alone does not save anything. The article's Status field is not loaded; the current status in the form remains. Saving adds the old text as a new revision and regenerates the English translation.

Deleting an Article

1. Click the Delete article button on the editing page.
2. The Delete this article? window explains the article will be removed from all readers and CLAI and the action is irreversible; the article's slug is shown.
3. Confirm by clicking Delete article or cancel with Cancel.

On successful deletion, a notification Article deleted appears and you return to the article list. Because deletion is irreversible, if you want to hide the article from readers only, set its status to Archived and save. The Delete article button does not appear for new (unsaved) articles and is disabled while saving.

Statuses

Article Status

Freshness Status

Detail / Editing Page

The editing page title is New help article for new articles; below it is the note Write in Turkish; the English version is generated on save. For existing articles, the title is the article's name; below is the date and user of the last save.

Form Fields

If you press Save with invalid fields, a Some fields need to be fixed notification appears, errors are shown below fields, and saving is blocked. If saving fails, a Could not save the article notification appears; your input remains in the form.

Text Editor

On wide screens, the writing area is on the left and live preview on the right; on narrow screens, switch between them with the Write / Preview buttons above.

The toolbar has buttons for Bold, Heading, List, Link, and Code. When text is selected, formatting applies to the selection; if no selection, sample text is inserted and selected. Heading and List apply to all selected lines; Link inserts with the address part selected; Code converts multi-line selection to a code block.

Button and field names on screen are written in bold in the text. When generating the English translation, bold (or quoted) tags are matched with the console's own tag dictionary; thus, the English article uses the actual tag shown on screen.

Bottom Panels

Until the article is saved for the first time, these panels show the note English translation and revision history will appear here after the first save.

• Freshness: Last freshness decision, date, reason, and change details. The Still accurate — take today's code button is here; unlike the list, it is visible even if the decision is Up to date.
• English translation: Read-only; not editable here, regenerated from Turkish text on each save. The Up to date badge means the translation matches the latest Turkish text; the Outdated — will be re-translated on next save badge means the Turkish text changed after translation. If no translation exists, No English translation yet is shown.
• Revisions: Save history of the article (see "Reverting to an Older Revision"). If none exist, No revisions yet is shown; if loading fails, Could not load revisions is shown.

Common Situations

• "Turkish saved but English translation could not be generated" warning appears. The Turkish article is saved; only translation failed. The reason is shown below the warning. Retry saving later; monitor status in the English translation panel.
• "An article with this slug already exists" is shown below the Slug field. The new article's slug duplicates an existing article. Change the slug or find and edit the existing article in the Articles tab.
• I wrote an article but it does not appear in the screen's help drawer. The article may be Draft or Archived, or the screen is not listed in the Linked screens field. Set status to Published, link the screen, and save. The screen's badge in the Screen coverage tab should be Published.
• "Help service not configured" warning appears. Articles cannot be read or saved; tabs are hidden and the New article button is disabled. This is a configuration issue; notify your system administrator.
• "Article not found" is shown. The article may have been deleted or the slug in the URL is incorrect. Use ← Back to articles to return to the list and search.

Related Screens

• Help center
• How Help and CLAI work together
• Navigating the console
• Using list screens