SalesFam Documentation

Technical documentation for the SalesFam platform (Marketplace • Sales Tracker • CRM), built with Docusaurus and published to GitHub Pages at https://evuventures.github.io/Salesfam/.

Getting started

npm install
npm start

Starts a local dev server with live reload — open the URL it prints.

Build

npm run build

Generates the static site into build/. Fails the build if any internal link is broken (onBrokenLinks: 'throw' in docusaurus.config.js), so run this before pushing anything that touches navigation or links.

Deployment

Deployment is automatic: every push to main triggers .github/workflows/deploy-docs.yml, which builds the site and publishes it to GitHub Pages. There is nothing to run manually — do not use docusaurus deploy (npm run deploy) for this repo, it's not how this site is published.

Documentation structure

The docs are organized the way the source Blueprint proposes: numbered chapters in docs/ (01-blueprint ... 09-technology-stack), and inside every chapter from 02-functional-requirements through 08-implementation-plan, one subfolder/file per Functional Requirement (fr-01-iam, fr-02-merchant-product, ...). See docs/intro.md for the full map — it's the site's own landing page too.

Adding or extending a Functional Requirement

main is protected — changes go through a Pull Request, not a direct push (except for infra-level pushes an admin explicitly decides to do outside this flow). To add a new FR, or extend an existing one, in any chapter:

1. Create a branch named after the FR you're working on:

   git checkout main
   git pull
   git checkout -b fr-03-rep-onboarding-commission-contracts

2. Install dependencies (first time, or after a package.json change):

   npm install

3. Add the content through the form — don't hand-write the Markdown/frontmatter. Run:

   npm run new:fr

   Open the printed URL (http://localhost:4000 by default). Choose the Section (Functional Requirements, Domain Model, Database Design, API Endpoints, Security, Architecture, Implementation Plan) and the FR — an existing one, or create a new one on the spot. The form creates the page if it doesn't exist yet for that section, or lets you append a new section if it does. Repeat once per chapter the FR needs (e.g. Functional Requirements first, then Architecture, Security, and so on as the design is ready).

4. Preview it before committing:

   npm start

   Confirm the new page(s) render correctly, links resolve, and any diagrams look right.

5. Commit and push the branch:

   git add docs/
   git commit -m "Add FR-03 — Rep Onboarding & Commission Contracts"
   git push -u origin fr-03-rep-onboarding-commission-contracts

6. Open a Pull Request into main. Once it's reviewed and merged, the site redeploys automatically — no extra step needed.