Updating These Docs

This site is built with Docusaurus and all content is written in Markdown. You don't need to know how to code to update it.

Quick Edits

Editing an Existing Page

1. Find the file in the docs/ folder — each page is a .md or .mdx file
2. Open it in any text editor
3. Edit the content using Markdown syntax
4. Save the file
5. If running locally, changes appear instantly in the browser

File Locations

Section	Folder
Overview	docs/overview/
Architecture	docs/architecture/
Roadmap	docs/roadmap/
Business	docs/business/
Guides	docs/guides/

Adding a New Page

1. Create a new .md file in the appropriate folder
2. Add frontmatter at the top of the file:

---
sidebar_position: 3
title: My New Page
description: A brief description
---

# My New Page

Your content here...

3. The page will automatically appear in the sidebar based on sidebar_position

Running Locally

Prerequisites

• Node.js version 18 or higher
• npm (comes with Node.js)

Start the Dev Server

cd "/Users/mdmac/Projects/Tap AI"
npm start

This starts a local server at http://localhost:3000 with hot-reload — changes to markdown files appear instantly in the browser.

Build for Production

npm run build

This generates static files in the build/ folder.

Markdown Tips

Links

[Link text](https://example.com)
[Link to another doc](./other-page)

Tables

| Column 1 | Column 2 |
|----------|----------|
| Cell 1   | Cell 2   |

Mermaid Diagrams

Wrap diagram code in a mermaid code block:

```mermaid
graph TD
    A[Start] --> B[End]
```

See the Mermaid documentation for diagram types and syntax.

Admonitions

:::tip
Helpful tip here.
:::

:::warning
Important warning here.
:::

:::info
Informational note here.
:::

Deploying Changes

After editing:

1. Commit your changes:

git add .
git commit -m "Update docs: description of change"

2. Push to GitHub:

git push

If Vercel is connected, the site will auto-deploy. Otherwise, run npm run build and deploy the build/ folder manually.

Site Configuration

The main configuration file is docusaurus.config.ts. Common changes:

What	Where
Site title and tagline	title and tagline fields
Navigation bar links	themeConfig.navbar.items
Footer links	themeConfig.footer.links
Sidebar structure	sidebars.ts
Color theme	src/css/custom.css