Engineering Portal

Adding content to the portal

Add a page#

  1. Create a markdown file under content/troubleshooting/ for an investigation, or content/references/ for lookup material. The folder decides the section.

  2. Start it with front-matter:

    ---
    title: Short, specific title
    summary: One sentence shown on cards and in search.
    tags: [wrike, api]
    status: open
    updated: 2026-10-22
    ---
    
  3. Run npm run build, then npm run serve and open http://localhost:8080/.

Front-matter#

KeyMeaning
titlePage title
summaryCard and search text
tagsComma-separated list in [ ]. Each tag gets an entry on the tags page
statusopen, in-progress, findings-ready, resolved or reference
updatedYYYY-MM-DD. The newest pages are listed first
scriptsOptional list of files from src/assets/ to load on that page

Writing#

  • Plain GitHub-flavoured markdown. ## and ### headings make the "On this page" list.
  • Callouts: start a quote with > [!NOTE], > [!WARNING], > [!OPEN] or > [!FINDING].
  • Link to other pages with their .md path. The build turns it into .html.
  • Keep raw captures out of the page. Put them in a folder listed under STATIC_COPIES in build.mjs. They are published under samples/ and linked from the article.
  • Mark what you observed separately from what you inferred, and list what is still open.

Building and hosting#

npm run build writes the whole site to dist/. It needs no server, so any static host works. Search and navigation also work when dist/index.html is opened straight from disk.