Documents, reports, and the dashboard¶

Documents¶

A document is a Markdown page in Imbi, for example a runbook, a design decision, or a review. Each document is attached to one of these:

Documents in the top bar (/documents) lists the documents of the selected organization.

• Activity feed shows the documents, newest change first.
• Index shows a table with the columns Document, Attached to, Author, Tags, and Updated.
• Search all documents… filters both views.

On a project, the Documents tab shows the project documents. The tab label shows the count, for example Documents (4). Use Search documents and the Tags filter to find a document. Pinned documents show first, under Pinned.

Write a document¶

1. Click New document.
2. Select Blank document, or select a template. When no template applies, the button makes a blank document at once.
3. On the Documents page only: select the attachment in Attach to. The choices are Personal and each project type.
4. Enter the Title.
5. Optional: add tags.
6. Write the content in Markdown. Use Write, Split, or Preview to change the view.
7. Click Save. Click Discard to leave without a save.

To change a document, open it and click Edit.

Templates¶

A template gives a new document its title, content, and tags. An administrator makes templates in Admin. See Catalog settings.

The New document menu shows only the templates that apply:

• A project template applies to project documents. It can be limited to some project types.
• A project_type template applies to project type documents.
• A user template applies to personal documents.
• A global template applies everywhere.

On the Documents page, the menu shows every template. A project_type template selects its project type in Attach to for you.

Someone else is editing¶

When you edit a document, Imbi marks you as an editor of it. Other people who edit the same document see a notice: "\<name> is also editing this document — the last save wins."

The notice is advisory only. Imbi does not lock the document. When two people save, the second save replaces the first. Each save is in the history, so you can restore the content that was replaced.

The editor sends a heartbeat to keep the mark. A mark expires 30 seconds after the last heartbeat.

History and restore¶

Each save that changes the title, the content, or the tags makes a new version. A save that changes only the pin makes no version.

1. Open the document.
2. Click History.
3. Select a version. Each version shows its kind (Created, Edited, Restored, or Original), who saved it, and when.
4. Click Content to read the version, or Changes to see the difference between the version and the current document.
5. Optional: click Restore v\<n>, then Restore to confirm.

A restore does not remove history. It saves the old content as a new version of the kind Restored. A tag that no longer exists is dropped.

Original is the content of a document that existed before Imbi recorded versions.

Pin, like, and comment¶

• Pin puts a project document in the Pinned group of the Documents tab. Unpin removes it.
• Like adds your like. Click Liked to remove it.
• To comment on a part of the text, select the text and use the toolbar that shows. Comments that are not on a part of the text show under the document. Use Open and Resolved to filter the comments. Use Hide inline comments to hide the marks in the text.

Who read a document¶

Imbi records how people read each document. Open a document and click the readers count, for example 4 readers. The Readership popover has two views:

• Views shows the views (all time), the unique readers, and the recent readers.
• Engagement shows how long people read and how far they scrolled.

Click View full readership report to open the report for all documents.

Imbi counts a read like this:

1. While the document is visible and you use the page, the browser sends a heartbeat every 15 seconds.
2. A visit with less than 5 seconds of engaged time is not a view.
3. A view is a read when you scroll to 80% of the document, or when you stay for its estimated read time (220 words a minute).
4. A visit ends after 5 minutes with no heartbeat.

These rules also apply:

• The counts show human reads in the web UI only. A fetch by the assistant, an MCP client, the Slack bot, or the API is not a read.
• The author's own reads do not count.

The names of the readers are private by default. The organization setting document_analytics_identities controls who sees them:

The UI has no control for this setting. Change it with the organizations API. You always see your own reading history.

Document permissions¶

Reports¶

Click Reports in the top bar. The left side lists the reports. Each report has its own URL, /reports/<id>. /reports opens Monthly Improvement.

Notes on some reports:

• Document Readership shows a maximum of 100 documents. Stale means read, but not in the last 90 days. Never read means that no person opened it. The counts follow the rules in Who read a document.
• Score History marks each change event with its cause, for example Attribute, Blueprint, Policy, Rescore, or System. For scores, see Operations log and scoring.
• Team KPI and Score History show no data until Imbi scores the projects.

Dashboard¶

The dashboard (/dashboard) is the first page after you sign in. / and each unknown URL also open it. Click the Imbi logo in the top bar to go back to it.

Widgets¶

For the pull request widgets, see Pull requests on the dashboard. Active Deployments reads only 50 entries, so it can show fewer active deployments than exist.

Change the dashboard¶

1. Click Customize.
2. In Customize Dashboard, click a widget to add it or remove it.
3. Close the dialog.
4. Drag a widget to move it.

Imbi keeps your widgets and their order in your browser only. Another browser shows the default widgets.

At the top of the dashboard, Imbi shows a card for each identity provider that you did not connect. See Connections.