|
1 | 1 | # ContextSuite Documentation |
2 | 2 |
|
| 3 | +The official documentation site for **ContextSuite** — an AI-powered eCommerce platform for mid-market and enterprise retailers delivering dynamic pricing, AI sales agents, real-time analytics, and connected intelligence. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +This site documents the **Semantic Events** system, an advanced event tracking and analytics framework that extends the standard Segment.com event schema with rich context, classification, sentiment analysis, and enriched metadata for operational insights. |
| 8 | + |
| 9 | +### Key Documentation Sections |
| 10 | + |
| 11 | +- **Semantic Events** — Introduction, best practices, and getting started guides |
| 12 | +- **Core Functions** — API reference for `page`, `screen`, `identify`, `group`, `alias`, and `track` |
| 13 | +- **Event Bible** — Industry-specific event templates covering 12+ verticals (Travel & Hospitality, Automotive, Food & Dining, Real Estate, and more) |
| 14 | +- **Event Schema** — Comprehensive schema reference including context, classification, commerce, enrichments, sentiment, and more |
| 15 | + |
| 16 | +## Tech Stack |
| 17 | + |
| 18 | +- [Next.js](https://nextjs.org/) — React framework |
| 19 | +- [Markdoc](https://markdoc.dev/) — Markdown-based documentation authoring |
| 20 | +- [TypeScript](https://www.typescriptlang.org/) |
| 21 | +- [PrismJS](https://prismjs.com/) — Syntax highlighting |
| 22 | + |
| 23 | +## Getting Started |
| 24 | + |
| 25 | +```bash |
| 26 | +# Install dependencies |
| 27 | +npm install |
| 28 | + |
| 29 | +# Run the development server |
| 30 | +npm run dev |
| 31 | +``` |
| 32 | + |
| 33 | +Open [http://localhost:3000](http://localhost:3000) to view the docs locally. |
| 34 | + |
| 35 | +## Project Structure |
| 36 | + |
| 37 | +``` |
| 38 | +pages/ # Markdoc documentation pages |
| 39 | + docs/ |
| 40 | + semantic-events/ |
| 41 | + bible/ # Industry-specific event templates |
| 42 | + schema/ # Detailed schema reference |
| 43 | +components/ # React components (navigation, code blocks, callouts, tabs) |
| 44 | +markdoc/ # Custom Markdoc tags, nodes, and functions |
| 45 | +public/ # Static assets and JSON schema |
| 46 | +``` |
| 47 | + |
| 48 | +## License |
| 49 | + |
| 50 | +Proprietary — ContextSuite / SmartData HQ |
0 commit comments