# Nexus Core Wiki Source

All Markdown sources for the in-app wiki live here.

## Goal

The wiki is no longer treated as a one-off HTML page. It is the long-term documentation source for the product.

This means:

- every app feature and tool gets its own Markdown document
- the API has a dedicated route documentation area
- screenshots, example inputs and step flows are documented at the source
- the static in-app wiki can be rebuilt from these files at any time
- production wiki files also receive English and French variants

## Required folder structure

```text
wiki/
  wiki-info.md
  app/
    app-index.md
    {app-area}/
      {file}.md
  api/
    api-index.md
    {area}/
      {file}.md
```

## Required content per Markdown file

1. purpose of the area or tool
2. route or entry point
3. important buttons, menus and dialogs
4. step-by-step workflow
5. example inputs or example records
6. common pitfalls
7. at least 3 images
8. maintained `en` and `fr` variants once the page is visible in the in-app wiki

## Image rules

Each larger documentation page should contain at least 3 images:

1. overall view of the area
2. detail view of a relevant dialog, menu or button
3. resulting state after the main action

Images should show:

- click order
- visible buttons and menus
- example values
- the state before and after an action

## Maintenance flow for new features

When a new feature is added:

1. choose the matching documentation area
2. add a new Markdown file or extend an existing one
3. document example inputs
4. create at least 3 screenshots
5. document the API route when the feature uses one
6. add English and French Markdown files
7. rebuild the static wiki afterwards

## Maintenance flow for UI changes

When buttons, dialogs or sequence change:

1. open the affected Markdown file
2. update the step flow
3. renew the screenshots
4. review the example inputs
5. align the language variants
6. review the API docs if requests changed
