Introduction & Core Architecture

Understand the core design philosophy, execution pipeline, and structural paradigms behind DocuCraft.

Design Philosophy

DocuCraft provides a unified, distraction-free technical documentation platform engineered for enterprise standards. It embraces strict typographic hierarchy, responsive multi-level navigation trees, resilient offline-first search, and seamless continuous integration.

Whether you need an API reference manual for an enterprise SDK or a comprehensive developer guide, DocuCraft delivers with zero framework bloat and total deployment portability.

Execution Pipeline

Every documentation request flows through an in-memory client-side cache before hydrating interactive elements. This ensures instantaneous transitions between articles, multi-language code snippets, and live test consoles.

import { createPipeline, Middleware } from '@docucraft/core';

// Initialize the deterministic documentation pipeline
const pipeline = createPipeline({
  caching: 'stale-while-revalidate',
  syntaxEngine: 'tokenized-ast',
  searchIndex: 'inverted-prefix',
  themePersistence: true,
});

pipeline.use(async (ctx, next) => {
  const start = performance.now();
  await next();
  ctx.headers.set('X-Response-Time', `${performance.now() - start}ms`);
});

export default pipeline;

Key Architectural Principles

1. Zero-Lockin Deployment: Deploy as a pure static HTML page on GitHub Pages, Cloudflare, Netlify, or export as Jekyll markdown.
2. Accessible by Default: Fully conforms to WCAG AA color contrast guidelines, screen-reader landmarks, and touch target minimums.
3. Universal Code Highlighting: Syntax-colored code blocks across 6+ languages with copy verification, line indicators, and diff badges.
4. Built-In CI Automation: Production-ready GitHub Actions workflows for link validation, markdown linting, and automated static page publishing.