↳Docs Refactor Desk LOCAL WORKSPACEGuide & rules
DOCUMENTATION MAINTENANCE / 01

Know what breaks.
Before you move it.

Reference checks, navigation coverage, and a refactor plan — from one local snapshot.

Files stay in your browser.No uploads. No repository changes.
REVIEW DESKAll files
v1.0
TAKE THE REVIEW WITH YOU

Download reports or a restorable project.

Recheck after editing

Ready. Choose a folder, restore a project, or try the example.

THE WORKING AGREEMENT

A source check, with clear boundaries.

01 / WORKFLOW

Import. Inspect. Rehearse.

Select the documentation root so relative paths stay intact. Choose the entry page, review broken references and reverse links, then stage file moves or heading renames.

Confirm the mapping to download a plan. Make changes in your own editor, import a revised snapshot, and compare the expected destinations. Save a project JSON to resume later.

Snapshot JSON format
{"files":[
  {"path":"README.md","text":"# Hello"},
  {"path":"assets/logo.svg","size":163}
]}

Only Markdown text is read. Other files are recorded by exact path and byte size. Project exports include original Markdown and asset metadata; keep them as private as your documentation.

02 / FIXED RULES

Know the dialect.

CommonMark via remark-parse 11.0.0, GFM via remark-gfm 4.0.1, and github-slugger 2.0.0. Heading IDs use lowercase, punctuation removal and ordered duplicate suffixes. Unicode is retained where supported by that slugger.

Paths are case-sensitive. Root-relative paths resolve at the selected root. Percent encoding is decoded once; query strings do not affect file lookup. A fragment is checked against the exact generated ID. Code fences never create headings or links.

Inline links, images and defined references are inspected. Undefined Markdown references remain literal text under CommonMark. Shared definitions are one edit location. Images do not create navigation edges.

03 / LIMITS & PRIVACY

Unknown means unchecked.

MDX, JS, raw HTML IDs/links, custom heading IDs, frontmatter, wiki links, templates, framework routes, redirects, extensionless routes and directory indexes are unsupported. No user code or HTML is run. External URLs are listed without requests. Assets are presence-checked only.

Up to 500 files, 250 KB and 20,000 lines per Markdown file, 5 MB Markdown / 20 MB total, 24 path levels, 64 AST levels, 100,000 nodes per file, 10,000 references, 12 MB project JSON, and an 8-second worker deadline.

Document text and filenames stay in memory until you download or close the page. No analytics, external fonts, paid APIs, keys or browser storage. Hosting may process ordinary page requests; no document data is sent. After loading, the workspace works offline.

Free tools already do valuable work here.

lychee offers mature command-line link checking. remark-validate-links offers MIT-licensed Markdown validation; its browser API checks same-file headings; the CLI can also check files and cross-file headings. This desk adds a local, reviewable snapshot workflow. Docusaurus routing is a reminder that source paths are not built routes. No traffic or revenue claims have been verified.