Actian Data Intelligence Platform — Documentation

This repository contains the source for the Actian Data Intelligence Platform documentation site.

Repository: https://github.com/ActianCorp/zeenea-platform-docs

The site is built with MkDocs Material and covers the full Actian Data Intelligence Platform — catalog design, stewardship, connectors, APIs, scanners, and more.

---

Repository Structure

zeenea-platform-docs/
├── docs/                        # All documentation source files (Markdown)
│   ├── index.md                 # Landing page
│   ├── Getting_Started/         # First steps and definitions
│   │   └── Your_First_Step/     # Role-based first steps
│   ├── Features/
│   │   ├── actian_mcp_server/   # Actian MCP Server
│   │   ├── Stewardship/         # Data stewardship workflows
│   │   ├── Zeenea_Administration/  # Admin: users, connections, scanners
│   │   ├── Zeenea_Explorer/     # Explorer: search, AI, favorites
│   │   └── Zeenea_Studio/       # Studio: catalog design and stewardship
│   ├── Integration/
│   │   ├── APIs/                # REST & GraphQL API references
│   │   ├── Connectors/          # Per-connector configuration guides
│   │   └── Scanners/            # Scanner setup, filters, plugins
│   └── misc/                    # Platform introduction and miscellaneous
├── .github/workflows/           # GitHub Actions CI/CD
│   ├── ci.yml                   # PR build checks
│   └── deploy.yml               # GitHub Pages deployment
├── hooks/                       # MkDocs build hooks
│   ├── bitbucket_edit_url.py    # Generates per-page edit links
│   └── custom_lexers.py         # Custom syntax highlighter definitions
├── theme_overrides/             # MkDocs Material theme customizations
│   ├── main.html                # Base template override
│   ├── home.html                # Custom landing page template
│   └── assets/stylesheets/      # Custom CSS (landing page, dark mode, etc.)
├── utils/                       # Helper scripts for content maintenance
├── mkdocs.yml                   # MkDocs configuration
└── requirements.txt             # Python dependencies

---

Local Setup

Prerequisites

• Python 3.9+
• pip

Install dependencies

pip install -r requirements.txt

Serve locally

mkdocs serve

Then open http://127.0.0.1:8000 in your browser. The server watches for changes and auto-reloads.

Build the static site

mkdocs build

The output is written to the site/ directory.

---

Contributing

Option 1 — Edit directly from the documentation site (recommended)

Every page on the published site has a pencil icon (✏) in the top-right corner of the page content. Clicking it opens the source Markdown file in Bitbucket, pre-set to the main branch in edit mode.

1. Navigate to the page you want to update at https://testdocs.actian.com/intelligence_platform/
2. Click the ✏ Edit icon on the top right of the page.
3. Log in to Bitbucket if prompted.
4. Make your changes in the Bitbucket editor.
5. Commit your changes and open a Pull Request targeting the main branch.

Option 2 — Clone and edit locally

git clone https://alm.actian.com/bitbucket/users/bpandey/repos/intelligence_platform
cd intelligence_platform
pip install -r requirements.txt
mkdocs serve

Edit files under docs/, preview at http://127.0.0.1:8000, then push your changes and open a Pull Request.

---

Authoring Guidelines

• All pages go under docs/ and use .md (Markdown) format.
• Every page should begin with a YAML front matter block:

  ---
  title: Page Title
  description: A brief one-sentence summary of this page.
  tags: [relevant, tags]
  ---

• Use # for a single top-level heading per page.
• Use !!! note, !!! tip, !!! important for callout boxes (admonitions).
• Fenced code blocks must specify a language tag (e.g., ```json, ```bash, ```yaml).
• Image references should always include alt text: ![Description of image](./images/example.png).
• Cross-references between pages use relative .md paths: [Link text](../other-page.md).
• Navigation order is controlled by .pages files in each folder (via the awesome-pages plugin).
• The custom sidebar (cn-nav.js) is regenerated from those same .pages files on every mkdocs build / mkdocs serve. To refresh it manually: python scripts/generate_cn_nav.py.

---

Technology Stack

Component	Technology
Static site generator	MkDocs
Theme	MkDocs Material
Versioning	mike
Diagramming	Mermaid.js, PlantUML
API docs	swagger-ui-tag
Navigation	awesome-pages
Search	MkDocs Material built-in

---

License

Copyright © 2026, Actian. See LICENSE for details.