Skip to content

1.0.1

Choose a tag to compare

View all tags
@kevinforter kevinforter released this 05 Mar 16:42
· 1 commit to main since this release
1.0.1
a6d4d57

Release Notes: AsciiDoc Integration & Mermaid Plugin Requirement

Version: 1.0.1
Release Date: 2025-03-12

Overview

This release introduces full AsciiDoc support for our documentation. By integrating AsciiDoc, we have enhanced our documentation capabilities, making it easier to maintain clear, structured, and easily rendered project documents. Additionally, we now require a Mermaid plugin to support diagram rendering within our AsciiDoc files.

New Features

  • AsciiDoc Documentation Integration:

    • Added support for writing documentation in AsciiDoc format.
    • Integrated with Asciidoctor to render AsciiDoc files into HTML and PDF formats.
    • Enhanced support for embedding diagrams and structured content directly within AsciiDoc files.

  • Mermaid Diagram Plugin:

    • Important: A Mermaid plugin is now required for rendering diagrams. Ensure that the Mermaid CLI (mmdc) is installed and configured properly in your environment.
    • This integration allows you to include Mermaid diagrams in your AsciiDoc documentation, improving the visual representation of complex processes and architectures.

  • Improved Documentation Pipeline:

    • Updated build scripts to process AsciiDoc files automatically.
    • Added templates and guidelines to help developers create consistent and well-organized documentation.

Improvements

  • Enhanced Clarity and Maintainability:
    The new AsciiDoc format provides a clean and modular way to manage documentation, making it easier to update and maintain as the project evolves.

  • Modern Documentation Approach:
    Leveraging AsciiDoc allows better integration with CI/CD pipelines, ensuring that the latest documentation is always generated and published.

Known Issues

  • Some legacy documentation may require manual conversion to fully leverage AsciiDoc features.
  • Additional configuration may be necessary in certain environments to properly integrate the Mermaid plugin and ensure that the mmdc executable is available in the system PATH.

Upgrade Instructions

  • Ensure that the latest version of Asciidoctor is installed in your environment.
  • Install the Mermaid CLI globally via npm: 
    npm install -g @mermaid-js/mermaid-cli
Assets 2
Loading