ZYVOPDOCS
MULTI-PLATFORM SYNC
Platform Features

Article Series & Collections

Group related articles into structured, ordered multi-part publications with unified navigation and reading progress.

Article Series & Collections

ZyVOP provides first-class support for Series — ordered multi-part editorial publications such as full-length courses, architectural deep dives, or multi-week tutorials.


Why Use Series?

When writing comprehensive technical guides, publishing a 15,000-word monolith often overwhelms readers. Breaking your guide into a 5-part series offers key advantages:

  • Dedicated Series Landing Page: A central URL (/series/slug) with an overview, total estimated reading time, cover image, and ordered chapter index.
  • Sequential Navigation: Every article in the series automatically displays a previous/next navigation widget and an expandable series drawer.
  • Cross-Platform Syndication: When syndicating to platforms like DEV.to or Hashnode, ZyVOP maps the article to the corresponding remote series collection.
  • Dedicated Sitemap Index: All series collections are included in search engine sitemaps via getSeriesSitemap.

Creating a Series

Via the Web Dashboard

  1. Navigate to Dashboard → Series.
  2. Click Create Series.
  3. Provide:
    • Title: e.g., "Building a Production-Ready Raft Consensus Engine in Rust"
    • Slug: Unique URL identifier (e.g. raft-in-rust)
    • Description: An executive overview explaining what readers will learn
    • Cover Image: Upload or generate AI artwork (16:9 aspect ratio)

Via GraphQL API

GraphQL Mutation
mutation CreateNewSeries($input: CreateSeriesInput!) {
  createMySeries(input: $input) {
    id
    title
    slug
    description
    coverImage
  }
}
Variables
{
  "input": {
    "title": "Production Kubernetes Operator Development",
    "slug": "k8s-operator-guide",
    "description": "A comprehensive 4-part series on writing resilient Kubernetes controllers with controller-runtime and Kubebuilder."
  }
}

Assigning Articles to a Series

In Frontmatter

Reference your series slug or ID directly in your article's YAML frontmatter:

part-1.md
---
title: "Part 1: Controller Architecture and Custom Resource Definitions"
series: "k8s-operator-guide"
status: "PUBLISHED"
---

Ordering Chapters

You can reorder chapters at any time from the Series Management view. ZyVOP maintains sequential indexing so that updating the order updates the reader's next/previous links immediately.


Reader Experience

When a reader visits any article belonging to a series:

  1. Series Header Banner: Shows the series title, total parts (e.g., "Part 2 of 5"), and a quick link back to the series home.
  2. Next / Previous Navigation: Rendered at the bottom of the article to guide readers seamlessly to the next chapter.
  3. Interactive Table of Contents: A floating drawer listing all published parts with checkmarks indicating completed reading progress.

On this page