Skip to content
Smith Douglas Systems

How to use these docs

Signing in (hosted site)

Section titled “Signing in (hosted site)”

When the site is run with npm run start (not npm run dev), you must sign in with your Smith Douglas Active Directory account before any page loads. Use the same email and password as SMART / Workplace.

For setup and environment variables, see AD login & hosting (Developer mode).

User mode and Developer mode

Section titled “User mode and Developer mode”

The site opens in User mode — focused on SMART 1.0 and SMART 2.0 job guides and business workflows, with technical topics hidden from the sidebar.

Turn on Developer mode with the toggle in the header (desktop) or at the bottom of the mobile menu when you need additional content:

  • Database tables, SQL, and status-code cheat sheets
  • All applications (Builder Portal, Trade Portal, BC worker, etc.)
  • System architecture and technical app pages

SMART 1.0 and SMART 2.0 user guides stay in the sidebar in Developer mode — nothing is removed, only extra sections are added.

Your choice is saved in this browser (localStorage).

Section titled “Navigation”
  • The left sidebar is grouped by what you are trying to do.
    • SMART 1.0 and SMART 2.0 — step-by-step guides by module (always available; in User mode, technical siblings in those groups are hidden).
    • Communities & Land through After the Close — workflow concepts that apply in both apps.
    • Applications and Database Reference — Developer mode only.
  • The right sidebar is the table of contents for the current page.
  • Search (top right, or /) uses a Pagefind index built with the site. It works on the production server, npm run preview, and npm run dev after at least one npm run build (the index is copied to public/pagefind/ automatically).

How a page is laid out

Section titled “How a page is laid out”

Concept pages in User mode focus on:

  1. What it is — plain English.
  2. The lifecycle / flow — numbered steps or a diagram.
  3. Where it shows up — SMART 1.0 module or SMART 2.0 screen.
  4. Common gotchas — what trips people up.

Database table names, stored procedures, SQL, and schema detail are hidden unless you turn on Developer mode.

Status codes

Section titled “Status codes”

Lots, contracts, and service workflows use short codes on screen (for example rat for Ratified). Concept pages explain them in context. The full Status code cheat sheet is available in Developer mode.

Test database

Section titled “Test database”

Counts and SQL in the Database Reference assume:

  • Server: SDH-DC-SQLTST01.thesmartbuilder.local
  • Database: SmithDouglasCommunities

When the docs are wrong

Section titled “When the docs are wrong”

Edit the matching file under sdc-docs/src/content/docs/ and submit a pull request.