Publishing | Error Management

What it covers: How to publish error documentation to the community portal and register it in the error index.

Publishing Workflow

Publishing involves three steps:

Save the error page in the correct location
Update the error index
Commit and push to GitHub (automatic publishing)

1. File Organization

Directory Structure

UserGuides/docs/WebSites/ErrorManagement/
├── Process/
│   ├── index.html
│   ├── 01-defining-errors.html
│   ├── 02-documentation.html
│   └── 03-publishing.html
├── ErrorCodes/
│   ├── Index.html                    ← Error code registry
│   ├── Error-FlowStudio-100090.html
│   ├── Error-FlowStudio-100091.html
│   └── ... more error pages ...

Where to Save Error Pages

All error documentation files go in the ErrorCodes/ folder:

C:\BizFirstGO_FI_AI\UserGuides\docs\WebSites\ErrorManagement\ErrorCodes\
Error-PRODUCT-NUMBER.html

2. Update the Error Index

Every error code must be registered in ErrorCodes/Index.html. This is the searchable registry of all errors.

Index Page Template

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"><meta name="viewport" content="width=device-width,initial-scale=1">
<title>Error Code Index | Error Management — BizFirstAI</title>
<link rel="stylesheet" href="../../styles.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
<style>
.bfai-topbar-logo img{height:26px;display:block;}.bfai-topbar{position:fixed;top:0;left:0;right:0;z-index:200;background:#1e2736;border-bottom:1px solid #2d3a4a;height:40px;display:flex;align-items:center;padding:0 20px;}
.bfai-topbar-right{margin-left:auto;display:flex;gap:6px;}
.bfai-topbar-right a{font-size:12px;color:#b0c4d8;text-decoration:none;padding:4px 12px;border-radius:5px;display:flex;align-items:center;gap:6px;transition:background 0.15s,color 0.15s;}
.bfai-topbar-right a:hover{background:rgba(255,255,255,0.08);color:#fff;}
body{padding-top:40px;}
nav.sidebar{top:40px;height:calc(100vh - 40px);}
table { width:100%; }
tbody tr:hover { background: rgba(255,255,255,0.02); }
td { padding: 12px 8px; }
</style>
</head>
<body>

<div class="bfai-topbar">
  <a href="https://bizfirstai.com" target="_blank" class="bfai-topbar-logo">
    <img src="https://www.bizfirstai.com/website/assets/Logo/logo.png" alt="BizFirstAI">
  </a>
  <div class="bfai-topbar-right">
    <a href="https://bizfirstai.github.io/UserGuides/" target="_top"><i class="fa-solid fa-house"></i> Portal</a>
    <a href="https://community.bizfirstai.com" target="_blank"><i class="fa-solid fa-people-group"></i> Community</a>
  </div>
</div>

<nav class="sidebar">
  <div class="sidebar-brand">Error Codes<span>Reference</span></div>
  <div class="sidebar-section">Troubleshooting</div>
  <a href="Index.html" class="active">Error Index</a>
  <div class="sidebar-section">Navigation</div>
  <a href="../">← Error Management</a>
  <a href="../../">← Portal</a>
</nav>

<main>
  <div class="page-header">
    <div class="breadcrumb">
      <a href="../../" style="color:inherit;text-decoration:none;">BizFirstAI Portal</a> /
      <a href="../" style="color:inherit;text-decoration:none;">Error Management</a>
    </div>
    <h1>Error Code Index</h1>
    <p class="subtitle">Complete reference of all error codes across BizFirst products.</p>
  </div>

  <h2>FlowStudio Errors</h2>
  <table>
    <thead>
      <tr>
        <th>Error Code</th>
        <th>Description</th>
        <th>Category</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a href="Error-FlowStudio-100090.html">Error-FlowStudio-100090</a></td>
        <td>Error description</td>
        <td>Execution</td>
      </tr>
    </tbody>
  </table>

  <h2>AppStudio Errors</h2>
  <table>
    <thead>
      <tr>
        <th>Error Code</th>
        <th>Description</th>
        <th>Category</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a href="Error-AppStudio-200001.html">Error-AppStudio-200001</a></td>
        <td>Error description</td>
        <td>Validation</td>
      </tr>
    </tbody>
  </table>

</main>
</body>
</html>

Adding an Error to the Index

When you create a new error page, add a row to the appropriate product section:

<tr>
  <td><a href="Error-PRODUCT-NUMBER.html">Error-PRODUCT-NUMBER</a></td>
  <td>Short description of the error</td>
  <td>Category (Validation, Execution, Permission, System)</td>
</tr>

Keep the table sorted: Order error codes by number within each product section (100001, 100002, 100090, etc.)

3. Version Control & Publishing

Commit Your Changes

git add docs/WebSites/ErrorManagement/ErrorCodes/Error-PRODUCT-NUMBER.html
git add docs/WebSites/ErrorManagement/ErrorCodes/Index.html
git commit -m "Add Error-PRODUCT-NUMBER documentation"

Push to GitHub

git push origin main

GitHub Pages automatically publishes changes within ~60 seconds.

Public URLs

Once published, error pages are available at:

Community Portal

https://bizfirstai.github.io/UserGuides/WebSites/ErrorManagement/ErrorCodes/Error-FlowStudio-100090.html

Internal/Mapped URL

docs.BizFirst.com/WebSites/ErrorManagement/ErrorCodes/Error-FlowStudio-100090.html
(mapped to C:\BizFirstGO_FI_AI\UserGuides)

Linking to Errors

In Exception Messages

When throwing an error in code, developers can reference the documentation:

throw new Error(
  "Error-FlowStudio-100090: Check the docs at " +
  "docs.bizfirst.com/WebSites/ErrorManagement/ErrorCodes/Error-FlowStudio-100090.html"
);

In API Responses

{
  "errorCode": "Error-FlowStudio-100090",
  "message": "Cannot execute node with invalid input",
  "docURL": "https://bizfirstai.github.io/UserGuides/WebSites/ErrorManagement/ErrorCodes/Error-FlowStudio-100090.html"
}

In Console Output

Error-FlowStudio-100090: Cannot execute node with invalid input
For help, visit: docs.bizfirst.com/WebSites/ErrorManagement/ErrorCodes/Error-FlowStudio-100090.html

Publishing Checklist

☐ Error page saved in ErrorCodes/Error-PRODUCT-NUMBER.html
☐ Error added to ErrorCodes/Index.html in correct product section
☐ Error code is listed in correct numerical order in index
☐ All links in error page are correct (related errors, navigation)
☐ No broken internal links
☐ Committed to git with clear message
☐ Pushed to main branch
☐ Verified live on GitHub Pages (wait ~60 seconds after push)

Verification

After pushing, verify your error page is live:

Wait 60 seconds for GitHub Pages to rebuild
Visit the public URL in your browser
Check that all navigation links work
Verify related error links are correct
Test on mobile (responsive design)

Updating Existing Errors

To update an error's documentation:

Edit the error page in ErrorCodes/
Update the description in Index.html if needed
Commit: git commit -m "Update Error-PRODUCT-NUMBER documentation"
Push: git push origin main

Changes are live within ~60 seconds.

Archiving Old Errors

If an error code is deprecated:

Update the error page with a callout danger marking it as deprecated
Update the index table category to "Deprecated"
Add a link to the replacement error code if applicable
Keep the page online for historical reference

Summary

Action	File Location	Public URL
Create error doc	`ErrorManagement/ErrorCodes/Error-PRODUCT-NUMBER.html`	`docs.bizfirst.com/.../ErrorCodes/Error-PRODUCT-NUMBER.html`
Register in index	`ErrorManagement/ErrorCodes/Index.html`	`docs.bizfirst.com/.../ErrorCodes/Index.html`
Publish	Git push to main	Live within ~60 seconds

✓ Your error documentation is now live! Share the public URL with your team so they can reference it when troubleshooting.

Step 3: Publishing

Publishing Workflow

1. File Organization

Directory Structure

Where to Save Error Pages

2. Update the Error Index

Index Page Template

Adding an Error to the Index

3. Version Control & Publishing

Commit Your Changes

Push to GitHub

Public URLs

Community Portal

Internal/Mapped URL

Linking to Errors

In Exception Messages

In API Responses

In Console Output

Publishing Checklist

Verification

Updating Existing Errors

Archiving Old Errors

Summary