@lanjam-ai/docs

Help documentation package for LanJAM — a self-hosted, family-friendly AI chat application.

This package provides structured help articles and categories as TypeScript exports, consumed by both the LanJAM application and the marketing website.

What's Included

7 categories, 17 help articles covering:

Category	Articles
Getting Started	What is LanJAM, First Time Setup, Logging In
Your Profile	Changing Theme, Changing Passcode, Safe Mode Preference
Conversations	Creating Conversations, Searching Conversations, Understanding AI Responses
Files & Attachments	File Attachments
Safety & Privacy	Safety and Privacy
Admin	Managing Users, Managing AI Models, Ollama Setup, System Management
Developer	Developer Setup

Article content is written in Markdown and embedded as TypeScript string literals for zero-runtime parsing overhead.

Installation

This package is published to the GitHub Packages npm registry.

# .npmrc
@lanjam-ai:registry=https://npm.pkg.github.com

# Install
npm install @lanjam-ai/docs

Usage

import {
  HELP_ARTICLES,
  HELP_CATEGORIES,
  getArticleBySlug,
  getArticlesForCategory,
  getCategoryById,
  getAdjacentArticles,
} from "@lanjam-ai/docs/help";

// Get all articles
const articles = HELP_ARTICLES;

// Get a specific article
const article = getArticleBySlug("what-is-lanjam");

// Get articles in a category
const gettingStarted = getArticlesForCategory("getting-started");

// Get prev/next for navigation
const { prev, next } = getAdjacentArticles("first-time-setup");

Exports

@lanjam-ai/docs/help

Export	Type	Description
HELP_CATEGORIES	HelpCategory[]	All categories sorted by order
HELP_ARTICLES	HelpArticle[]	All articles with full Markdown content
getArticleBySlug(slug)	HelpArticle | undefined	Look up article by URL slug
getArticlesForCategory(id)	HelpArticle[]	Articles in a category, sorted by order
getCategoryById(id)	HelpCategory | undefined	Look up category by ID
getAdjacentArticles(slug)	{ prev, next }	Previous and next articles for navigation

Types

interface HelpCategory {
  id: string;
  title: string;
  description: string;
  icon: string;    // Lucide icon name
  order: number;
}

interface HelpArticle {
  id: string;
  slug: string;
  title: string;
  description: string;
  category: string; // References HelpCategory.id
  tags: string[];
  content: string;  // Markdown
  order: number;
}

Project Structure

lanjam-docs/
├── src/
│   ├── index.ts              # Re-exports from help.ts
│   ├── help.ts               # Categories, lookup functions, exports
│   └── articles/
│       ├── index.ts           # Aggregates all articles
│       ├── what-is-lanjam.ts
│       ├── first-time-setup.ts
│       ├── logging-in.ts
│       └── ... (17 articles)
├── biome.json
└── package.json

Development

# Format
pnpm format

# Lint
pnpm lint

# Format + lint
pnpm check

Adding a new article

1. Create a new file in src/articles/ following the existing pattern
2. Export the article object with id, slug, title, description, category, tags, content, and order
3. Add the import and include it in the array in src/articles/index.ts

Related Projects

• lanjam-chat — The main LanJAM application
• lanjam-site — Marketing website at lanjam.dev

Licence

MIT