Skip to content

v0.9.1 - Documentation & Type Safety Improvements (2025-12-27)

What Changed?

This release focuses on documentation improvements and type safety enhancements. The FAQ has been refactored as a quick reference guide, CLI format options now use Literal types for better type checking, and the documentation structure has been reorganized for easier navigation.

What's New

FAQ as Quick Reference

What it does: The FAQ page has been redesigned as a quick reference guide with concise answers and links to detailed documentation.

How to access: FAQ is now available in the top navigation bar for easy access by both users and developers.

Key features:

  • Concise 1-2 sentence answers with code examples
  • Admonition blocks (!!! info "ι–’ι€£γƒšγƒΌγ‚Έ") for reference links
  • Quick reference section with common error table
  • Cleaner URL: /dev-guide/faq/ (renamed from 10-faq.md)

Type-Safe Format Options

What it does: CLI --format option now uses Literal type annotation for better IDE support and type checking.

Supported formats: 

Literal["table", "jsonl", "json", "csv", "ssv", "tsv", "ltsv"]

Benefits:

  • Better IDE autocompletion
  • Compile-time type checking
  • Removed type: ignore comments

Installation

Quick Start

# Get the release
git checkout v0.9.1

# Setup
uv sync

# Run CLI
uv run kazunoko --help

What's Different from the Last Version?

βœ… Added

  • FAQ added to top navigation for better discoverability
  • Admonition blocks for reference links in FAQ

πŸ”§ Changed

  • Renamed 10-faq.md to faq.md for cleaner URLs
  • Refactored FAQ as quick reference with concise answers
  • CLI format parameter uses Literal type instead of str
  • Updated example script dependencies (added loguru, git+https reference)

πŸ“š Documentation

  • Consolidated Troubleshooting sections with cross-references
  • Consolidated Data Quality sections with cross-references
  • Unified installation instructions across documentation
  • Fixed option naming (--use-sec instead of --use-duration)
  • Reorganized navigation structure

Is It Safe to Upgrade?

Backward Compatible: Yes

  • No breaking changes to CLI or Python API
  • Documentation improvements only
  • Type annotation changes are internal

Tests Passed

  • βœ… Builds without errors (uvx ruff check)
  • βœ… Type checking passes (uvx mypy)
  • βœ… All CLI commands work as expected

Release Details

  • Date: 2025-12-27
  • Version: v0.9.1
  • Files Changed: 2 source files, multiple documentation files
  • Type: Patch release (documentation & refactoring)

Next Steps

  • StreamingStats implementation for event collection metrics
  • Additional Python API documentation
  • Performance optimization guides