Skip to main content

​
Import & Export — Wiki Authoring Guide

For: the Help Center author Goal: add the Import & Export pages to the VoxDash Help Center (Mintlify). Status: the pages and sample files below are already drafted in the repo — you mainly need to register them in the navigation and review the wording.

​
1. What is already prepared

I added these to the wiki repo (K:\Projects\docs): Pages — Import-Export/ (Mintlify .mdx, ready to publish): Sample download files — files/import-export/ (the .xlsx users download from each page):
Each page links to its sample with a download card.
Important — why the download links use a GitHub URL. Mintlify serves pages and images, but it does not serve .xlsx files as static downloads (they return 404). So each download card points to the file’s GitHub raw URL in this repo: https://raw.githubusercontent.com/onvoxdash/docs/main/files/import-export/<file>.xlsx. The .xlsx files still live in files/import-export/ — keep them there (on the main branch) so the raw links resolve.

​
2. Register the pages in the navigation

Open docs.json. Inside navigation.tabs[0].groups, add this one new group object (place it wherever you want it to appear — after “Survey Questions” reads well):
Page paths are without the .mdx extension and are case-sensitive — they must match the file names exactly.

​
3. Preview and publish

  1. From K:\Projects\docs, run mint dev and open http://localhost:3000.
  2. Confirm the Import & Export group appears and each download link works.
  3. Commit and push — Mintlify deploys automatically.

​
4. House style (so new import/export pages match)

Every page uses Mintlify components already in the starter:
  • Frontmatter at the top: title and description.
  • <Steps> / <Step title="..."> for procedures.
  • <Note>, <Tip>, <Warning>, <Info> for callouts.
  • A <Card title="Sample file" icon="file-arrow-down" href="/files/import-export/…"> for the download.
  • A Markdown table for Columns and another for Limits & rules.
  • A Troubleshooting table where the feature can fail.

​
Reusable page template

​
5. Keeping sample files up to date

The sample files come from the backend repo at voxdash-dotnetcore/docs/import_export_samples/. If a feature’s columns change, a developer regenerates them with dotnet run --project ImportExportSampleGenerator and you copy the new .xlsx over the ones in files/import-export/, then commit and push to main. The file names stay the same and the download links point at the GitHub raw URL on main, so replacing the file is all that’s needed — no page edit.
These import/export pages overlap with groups already planned in docs.json. When you write those pages, add a link to the matching Import & Export page: For the full description of every import/export surface — including ones that don’t yet have a sample file — see the companion Import-Export-Sites-Report.