Wikiwright

Wikiwright documentation

Everything Wikiwright does, where to find it, and how each part works.

Getting started

  1. A Confluence administrator installs Wikiwright from the Atlassian Marketplace. Sites with up to 10 users use it free; larger sites start Atlassian’s 30-day trial.
  2. Wikiwright starts reading the site at once. A site with a few thousand pages is usually ready within minutes; on a 50,000-page test site, a full rebuild took under ten minutes. Screens show progress until then.
  3. Open the dashboard:
    • Whole site (Confluence administrators): Confluence administration, then Wikiwright under Apps.
    • One space (anyone who can open the space): the space’s sidebar, Space apps, then Wikiwright.
  4. Start with This week’s clean-up plan and Fix these first on the Overview.

After that, Wikiwright keeps itself up to date: each edit is picked up as it is saved, and the whole site is checked for changes every night.

On every page

Linked from

Under each page title, Linked from N pages opens the list of pages that link to it, grouped by space, with a filter. Links from this page shows the other direction. Only pages you can open are listed.

Backlinks macro

Insert Backlinks (Wikiwright) on a page to show the pages that link to it in the page itself. Its settings filter the pages it shows (for example by label), and set their order and how many to show.

Link graph

From the page’s ••• menu, choose Apps, then Link graph: the page, what it links to and what links to it. Archived, trashed and missing pages have their own colors. Drag to move, scroll to zoom, click a page to open it. A space’s dashboard has a Link graph tab for the whole space.

Broken-link banner

People who can edit a page see a banner when its links are broken. Review and fix lists them, and each can be fixed right there. Readers never see the banner. Admins can turn it off.

Report a problem

Anyone reading a page can report a link that doesn’t open, goes to the wrong page or is out of date, with an optional note. Reports appear to the page’s editors and under Fix, then Reader reports.

The dashboard

Tab What it shows
Overview The link health score (the share of pages with no broken links, missing sections or missing files), counts for each kind of problem, why links are broken, the trend over time, this week’s clean-up plan and the targets to fix first.
Fix Broken links, missing sections, missing attachments and old-server links, plus find and replace and reader reports.
Clean up Links to archived pages, orphan pages, unused attachments and includes.
Organize Move pages and copy page trees with their links, archive a whole space safely, the space lifecycle report, handing over a leaver’s work, and personal spaces.
Content Pages not updated in 6, 12 or 24 months that others still link to, and pages that look like copies of each other.
Changes Every change Wikiwright made, who asked for it, and Undo. On a space’s dashboard, only changes in that space.
Settings Site settings (Confluence administrators only).

The site dashboard can be narrowed to one space or to the pages you own. Every list can be exported to CSV or Excel.

What counts as a problem

Label Meaning
No such page The link names a page title that no page has, in that space.
Deleted The linked page was deleted for good.
In the trash The linked page is in the space’s trash.
Archived The linked page is archived. Listed under Clean up; not counted in the health score.
Section not found The link goes to a heading or anchor that isn’t on the page. When a heading was renamed, the new name is suggested.
File not found The link or image uses an attachment that isn’t there.
Old server, repairable A hard-coded link to your old Server or Data Center address whose page exists here.
Old server, no match The same, but no page here matches it.
Can’t be checked A link to a page Wikiwright could read before but can’t now, usually because the page was restricted from the app. The link may well work.
No parent, no links An orphan page: at the top of its space with no page linking to it, so nobody can find it from the page tree or another page.
Not used An attachment no page links to, shows or uses in a diagram.

Links to whiteboards, databases, folders and Live Docs are understood and never reported as broken. Wikiwright checks links between Confluence pages; it doesn’t visit outside websites.

Fixing links

Fix by target

Broken links are grouped by the page they point at. Fix all fixes every link to that page in one step. Choose what to do:

Preview shows each page that will change, the link before and after. Nothing is saved until you confirm. Every link view also lets you fix one link at a time.

Undo

Each fix is saved as a new page version whose message names who asked for it. Changes lists every fix with Undo. Undo puts the links back and keeps any edits made to the page since. It can’t undo a fix on a page that has since been archived, or whose fixed link was removed by a later edit; the page’s own version history still can. Confluence notifies people watching a page when Wikiwright edits it, as with any edit.

Old server links after a migration

List your old Server or Data Center addresses under Settings, Old server addresses (for example wiki.example.com). Links to them are reported, and Repair all points those with a matching page here at that page.

Find and replace

Change link addresses across many pages at once: by domain, by address prefix, by exact address, or by pattern. A preview of the first pages comes first, then the change runs in steps and can be undone. With AI suggestions on, describe the change in words and Wikiwright writes the rule.

Triage

Mark a link as ignored or expected, or assign it to a person with a note. Assigned to me lists your links. The weekly plan can assign each week’s new broken links to the owners of their pages.

Moving and archiving pages

Confluence updates links itself when a page is moved or renamed. Archiving, trashing or deleting a page is what breaks them, as does moving a page to another space when old /display/ addresses point at it.

Before you archive, from the page’s ••• menu choose Apps, then Check links before moving or archiving. It lists every page that links to this page and the pages under it. From there:

Organize: move, copy, archive and hand over

The Organize tab changes where pages live, safely. Every change is made as you (so Confluence applies your permissions), is listed under Changes, and can be undone.

Move pages

Choose up to 25 pages and the page to move them under. The check shows what moves (with the pages under each), what won’t and why, and any old /display/ addresses a move to another space would break; Wikiwright updates those after the move. Undo moves each page back to where it was. A page’s own Check links before moving or archiving dialog can move it too.

Copy pages

Copy a page and the pages under it (or a whole space, from its home page) under another page. Confluence copies the pages and updates most links between them; links by page ID, short /x/ links and old /display/ addresses still lead to the originals, so Wikiwright points those at the copies, with a preview. Copies in the same space need a title prefix. Undo moves the copies to the trash, leaving any copy someone has edited, moved, or added pages under since.

Archive a space

Archiving a space keeps its pages, but links from other spaces then lead to archived pages. The check lists the space’s pages that other spaces link to. Point those links at replacement pages, or add an archive note to the linked pages, then archive the space. Only the space’s admins can archive it. Undo unarchives it; if someone unarchives the space in Confluence, the change is marked “Unarchived since, outside this change”.

Space lifecycle (administrators)

Spaces with no active owner, no edits for 3 to 24 months, three pages or fewer, or mostly broken links, with Archive safely and Assign an owner.

Hand over a leaver’s work (administrators)

People who own pages or spaces but whose account is no longer active (or anyone about to leave). For one person: the pages they watch, the pages they own, and the spaces they own.

Pages they own that you can’t open are counted, not listed: they are most likely restricted, so review them in Confluence.

Personal spaces (administrators)

Everyone’s personal spaces, with their owners and whether they are still empty (nothing but an unedited home page). By default Wikiwright only reports. You can choose to have it archive new personal spaces that are still empty 30 days after they were made: only spaces made after you turn this on, checked again in Confluence first. Each is listed under Changes, where an administrator’s Undo unarchives it, and a space unarchived once is never archived again by the policy. Nothing is restricted.

Cleaning up

The Rovo agent

Open Rovo chat, choose the agent Wikiwright, and ask in your own words. It uses the page you are on unless you name another one.

When asked to change something, the agent first shows exactly what it would change and waits for you to agree; Rovo then asks you to confirm the action. Moving, copying, archiving a space and handing pages over can only be carried out from the plan you were shown: Wikiwright keeps it for you for 10 minutes, carries it out once, and acts on exactly the pages, space or people in it. Changes made through the agent follow the same permission checks, appear under Changes, and can be undone.

Wikiwright’s actions are also available as tools to your own Rovo agents built in Rovo Studio.

AI suggestions

AI suggestions are off until a Confluence administrator turns them on under Settings. They use models hosted by Atlassian; nothing leaves Atlassian. They:

AI only suggests: every change still shows a preview and needs a person’s approval. The administrator sets a monthly limit (US$2 of estimated AI use by default, at most US$5); Settings shows this month’s use. AI use is included in Wikiwright’s price and isn’t billed to you. Each person can ask for up to 30 AI suggestions a day. When the limit is reached, Wikiwright’s own suggestions keep working. If your organization doesn’t allow apps to use AI models, AI suggestions stay off. See how Wikiwright uses AI.

Settings

Setting What it does
Link index Shows how many pages, links and attachments are indexed. Check for changes now re-reads what changed; Build full index reads every page again.
AI suggestions The switch, the monthly limit and this month’s use.
Published report Keeps a “Wikiwright report” page up to date in a space you choose, weekly or monthly, for people who don’t open the app. It shows counts and trends only, never page titles.
Weekly clean-up plan Prepares the plan now, and can assign each week’s new broken links to their pages’ owners.
Excluded pages Pages whose links don’t count (dashboards, generated indexes, meeting-note archives), by label, title pattern (* matches any text) or space key. The move and archive check still counts every link.
Who may fix links Anyone who can edit the page, space admins of the page’s space, or Confluence admins only. Everyone can still see the reports.
Broken-link banner Shows or hides the banner for editors.
Old server addresses The addresses of the wiki this site was moved from.

Who sees and changes what

Limits

Questions

Does Wikiwright check links to other websites?

No. It checks links between your Confluence pages, sections and attachments, and links to your old wiki address. It makes no requests outside Atlassian.

Why is a link listed that works for me?

Most often the page is restricted from the app, so Wikiwright can’t see it; it is then listed as “Can’t be checked”. If a page is listed as “No such page”, check that the link names the page’s current title and space.

Are blog posts included?

Yes. Pages, blog posts and Live Docs are indexed; whiteboards, databases and folders are recognized as link targets.

What happens when we uninstall?

Wikiwright’s data is held by Atlassian’s Forge platform. After uninstalling, it is kept for 21 days so a reinstall picks up where it left off, then deleted. Fixes already made stay on the pages, as normal page versions.

Where is our data?

In Atlassian’s cloud, with your Confluence data, in your data residency region. See Privacy and Security.