Skip to content

Latest commit

 

History

History

docs

README.md

undatum documentation

This directory contains the Docusaurus documentation site for undatum.

Development

Prerequisites

  • Node.js 18+ and npm

Installation

cd docs
npm install

Local development

Start the development server:

npm start

This starts a local development server and opens a browser window. Most changes are reflected live without restarting the server. From the repository root you can also run make docs-serve.

Build

Build the site for production:

npm run build

This generates static content into the build directory. From the repository root you can also run make docs.

Serve

Serve the built site locally:

npm run serve

Project structure

docs/
├── docusaurus.config.js    # Docusaurus configuration
├── sidebars.js             # Sidebar navigation
├── package.json            # Node.js dependencies
├── babel.config.js         # Babel configuration
├── src/
│   ├── css/custom.css      # Custom styles
│   ├── pages/index.js      # Homepage (documentation contents)
│   └── components/         # React components
├── static/img/             # Logo and favicon
└── docs/                   # Documentation content
    ├── getting-started/    # Installation, quick start, cookbook
    ├── use-cases/          # End-to-end examples
    ├── commands/           # CLI reference
    ├── formats/            # Format support matrix
    ├── integrations/       # SDK, MCP, Data API, cloud, plugins
    ├── development/        # Contributing and internals
    └── license.md

Deployment

The documentation is deployed to GitHub Pages at datenoio.github.io/undatum when changes are pushed to main. The workflow lives in .github/workflows/deploy-docs.yml.

GitHub Pages setup

  1. Open the repository settings on GitHub.
  2. Navigate to Pages.
  3. Under Source, select GitHub Actions.

See GITHUB_PAGES_SETUP.md for details.

Documentation structure

  • Getting Started: Installation, quick start, positioning, cookbook
  • Use Cases: Conversion, pipelines, quality, SQL, agents
  • CLI Reference: Command-by-command documentation
  • Data File Formats: Honest capability matrix (140+ formats via iterabledata)
  • Integrations: SDK, MCP, Data API, cloud storage, plugins
  • Development: Contributing, error-handling patterns, community

Contributing

When adding or updating documentation:

  1. Edit the markdown files in docs/docs/.
  2. Follow the existing frontmatter (title, description).
  3. Test locally with npm start.
  4. Confirm npm run build succeeds (broken links fail the build).