Skip to content

The wiki

Hussein Jarrar edited this page Sep 12, 2026 · 2 revisions

A space holds a tree of pages you write and read inside Radd. This page covers spaces, the editor, and everything a page can do: labels, versions, links to work items, and public sharing.

Spaces

A space is a named tree of pages. Use one space for a body of material that belongs together — a team's runbooks, or, as on this instance, the product's own documentation.

Open Pages in the sidebar to see every space you can read, one entry per space, each showing its name, its page count, and its description.

The Pages index, showing the Radd space with its page count and description.

Click Manage spaces to create a space, rename one, or make one public. You need the page.manage permission atom to see this link.

The page tree

Open a space to see its page tree on the left. Click a page to read it. Click the arrow beside a page to expand or collapse its children. A number badge on a collapsed page shows how many children it has.

A space's page tree, expanded to show a parent page and its two children.

Type in Filter pages… to narrow the tree by title. A match keeps its whole ancestor chain visible, so a deep result never floats free of its place in the tree.

Radd sets a page's place in the tree when you create it, under the page you had open. Radd has no tree control to move a page to a different parent afterward today.

TODO(verify): confirm whether moving a page to a new parent is planned for the interface — the server already accepts a parent change on the PATCH endpoint; only the tree has no control for it.

Create a page

Click New page at the bottom of the tree, or beside any page to create a child under it. Radd creates the page titled "Untitled" and opens it. Type a real title; Radd saves it when you click away from the title field.

An untitled page's URL segment follows its first real title automatically, once. After that, the URL stays fixed even when you rename the page again — a link someone already holds must keep working. Click the chain-link icon to change the URL segment on purpose; Radd warns you that the old address stops working.

Page templates

A template supplies a starting shape for a page you write often — a runbook, meeting notes, or a postmortem. An administrator manages the list of templates; each template belongs to one space, or to every space.

A template body may hold three placeholders: {{title}}, {{date}}, and {{author}}. Radd fills them in when you create the page from the template. Any other {{...}} text stays in the page, as a prompt to whoever fills it in.

Reading a page

A page shows its title, who last updated it, and its version number. The icon row lets you watch the page, change its URL, export it, restrict who can read it, and archive it.

A page in read mode, with its icon row, a collapsed Linked issues panel, and the discussion box below it.

Point at the body. Click the pencil icon that appears to edit a page. You need the page.write permission atom in the space.

Click the archive icon to archive a page. Radd hides it from the tree until you or another administrator restores it; nothing is deleted. Deleting an archived page permanently — history included — needs the page.delete permission atom, held by everyone with page.manage. This cannot be undone.

The editor

The editor shows a fixed toolbar above the text. It renders markdown live as you type, and the value it saves is always markdown.

The page editor open, showing every toolbar control: text style, marks, lists, insert, AI and extension buttons.

The toolbar offers:

  • A text-style menu: Paragraph, or Heading 1 through Heading 3.
  • Bold, italic, strikethrough, and inline code marks.
  • A link mark. Click it, then paste a URL into the tooltip that opens.
  • A bulleted list, a numbered list, and a quote block.
  • A code block. Select its language from a dropdown; a copy button sits beside it. Code looks the same in the editor and in read mode.
  • Image. Select a file to upload, or paste an image URL.
  • Table. Sweep a grid for the starting size. Use the row and column handles that appear to insert, remove, or align a row or column.
  • AI, when your administrator turned the feature on and you have not opted out on your profile.
  • Insert extension, covered below. Pages only — a comment has no page whose headings a table of contents could list.

Images

Point at an image. Drag the handle on its right edge to resize it, or use the Left and Right arrow keys for the same control from the keyboard. Click Reset to return the image to its full size.

The width you set rides in the image's own URL, as ?w=640. This keeps the page's body plain markdown. It also means the server sends a smaller file for a resized image, instead of your browser scaling down the full one. Radd can only resize its own attachments — an image hosted elsewhere draws at its natural size, with no resize handle.

Links and mentions

Type @ to mention a person by name, and # to mention a work item by its key. Both open a short list to select from as you type.

Paste an internal page link — in the form /pages/<space>/<page> — and Radd indexes it as a backlink on the page it points to (see below).

The radd: extension blocks

Click Insert extension to add a block that renders something live, instead of static text. Every extension is a fenced code block whose language is radd:<name>. It reads as real markdown to anyone opening the raw file, and as a plain code block wherever radd: blocks are not understood.

Block What it does
radd:toc This page's headings, and optionally the pages beneath it.
radd:children The pages directly beneath this one — as links, or as their full content, live.
radd:callout A tinted note: info, success, warning, or danger.
radd:backlinks Every page that links to this one, shown inline.
radd:include Another page's body, rendered here, live. Radd refuses to include a page into itself, directly or through a chain.
radd:label-list Every page carrying a label — an index that keeps itself current.
radd:new-from-template A button that creates a child page from a template.

An extension block reads with your own permissions. A page you may not read shows as "cannot be shown" inside an include; it never leaks its content.

Link a page to a work item

Type an issue key, such as RADD-1000, in the page body, and Radd links the page to that work item automatically. Remove the mention from the text, and Radd removes the link.

Open the collapsed Linked issues section to see every linked work item, and to link one by key by hand. A row Radd created from your text carries no remove button — the text owns that link, so remove the mention to remove it.

The work item itself shows a matching Pages row, so the link works both ways. See Work items.

Backlinks

A page's Linked from section, below the body, lists every live page that links to it. Radd rebuilds this index on every save, and it never shows the title of a page you may not read.

Use the radd:backlinks extension to place the same list inline, at the point in the page where it matters.

Labels

A page label is the same free-text tag a work item carries — tagging a page "runbook" and an issue "runbook" means the same thing on both. Click Add labels below the title to add or remove one.

Use the radd:label-list extension to build a page that lists every page carrying a given label, and keeps itself current with no editing.

Versions

Radd keeps every past version of a page's title and body. Open the History tab to see them, newest first. The version shown at the top of the page — "v38", for example — is the current one, and is not repeated in the list.

Version history for the Release notes page, listing over thirty past versions with their author and age.

Click a version to read it. Click the compare icon beside a version to see what changed between it and the version that came right after it. Click Restore vN to bring old content back. Radd writes it as a brand-new version, so history stays a straight line and nothing already saved is overwritten.

Watch a page

Click the bell icon to watch a page. Radd notifies you when someone else changes it. Editing a page watches it for you automatically — touching something is a sign you care what happens to it next.

See Notifications and the inbox for how a page notification reaches you.

Export and print

Click the printer icon to export a page. Export as PDF opens a print view in a new tab and starts your browser's own print dialog — select Save as PDF there. Export as PDF, with subpages adds every live page beneath it, each starting on a fresh sheet. The printed page always renders in light colors, whatever theme you use day to day.

Click Download as markdown (.zip) to save the page, and any live pages beneath it, as a folder of .md files. A link to another exported page becomes a relative link inside the archive. A link to anything outside it stays as it was, since it still points at your Radd instance.

radd:* blocks are written out as-is in an export — they stay real markdown, so importing the archive back does not lose them.

Public spaces

An administrator can make a space public from Settings → Page spaces, using the page.manage permission atom in that space. A public space needs no sign-in to read: anyone with the link can open its pages at a public URL. That same settings row shows a copyable link to it.

Archived pages never appear in a public space, and neither does a page's version history. A visitor with no account sees only the current body, and the page's place in the tree.

A public space's images still need a signed-in reader today. The server serves an attached image through a route that checks who is asking, so it does not load for a visitor with no account. Use an externally hosted image URL in a page you plan to publish.

Search pages

Press Ctrl+K (or ⌘K on a Mac) and start typing to search across work items and pages at once; page hits appear under their own "Pages" heading. See Search and the query language for how the command palette works.

The Filter pages… box in a space's tree only narrows what is already loaded, by title. It is not a full-text search.


Mirrored from project.radd-hq.com on 2026-09-12. Documentation is written there; this copy is regenerated by scripts/publish_wiki.py and hand edits do not survive it.

Clone this wiki locally