ingext-manual

README.md

Project Overview

This is the Fluency Ingext User Manual — a Docusaurus static documentation site for the Fluency Ingext SIEM platform, deployed at https://manual.ingext.io from the SecurityDo/ingext-manual GitHub repo.

Installation

$ npm install

$ yarn

Local Development

$ npm run start

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Common Commands

yarn install          # Install dependencies (Node >= 18 required)
yarn start            # Local dev server with hot reload
yarn build            # Build static site to /build
yarn serve            # Serve the built site locally
yarn docusaurus clear # Clear Docusaurus cache (useful when builds behave unexpectedly)

Deployment is via GitHub Pages using Docusaurus’s built-in deploy:

GIT_USER=<username> yarn deploy   # or USE_SSH=true yarn deploy

There are no test or lint commands. Broken links only produce build warnings (onBrokenLinks: 'warn'), so check build output when moving or renaming pages.

Architecture

Docusaurus 3.10.1 with the classic preset. Content is almost entirely Markdown/MDX — minimal custom React code.

Content Structure

• docs/ — Main user manual (~240 markdown files). Served at the site root (routeBasePath: '/'), so docs/platform/overview.md becomes /platform/overview.
• blog-announce/ — Announcements feed (served at /splash)
• blog-release/ — Release notes feed (served at /release; feed keeps the 10 most recent)
• src/pages/ — Homepage (index.js) and About page
• src/css/custom.css — Brand colors and global styles
• static/ — Images and static assets (large: ~82 MB of screenshots)

Configuration

• docusaurus.config.js — Main config: site URL, navbar, footer, the two blog plugins, and local search
• sidebars.js — Single auto-generated sidebar from the docs/ directory structure. Ordering comes from sidebar_position frontmatter, which every doc has; a few _category_.json files set category labels, positions, and generated-index pages. New pages need a sidebar_position to land in the right spot.

Search

Local client-side search via @cmfcmf/docusaurus-search-local — indexed at build time, no backend required. Blog feeds are not indexed.