fix: remove unnecessary UTF-8 encoding declarations and improve type …

[bybatkhuu]

This pull request includes a series of documentation and code improvements for the beans-logging Python package. The changes focus on updating documentation links, clarifying descriptions, modernizing type annotations, and cleaning up formatting and comments throughout the codebase. No functional changes to the package logic are introduced.

Documentation and Description Updates:

• Updated the package description in both pyproject.toml and mkdocs.yml to clarify that the package helps manage logs, not just logging. [1] [2]
• Fixed and standardized links in the README.md and documentation files to use relative paths where appropriate, improving navigation and consistency. [1] [2] [3] [4] [5]
• Removed video tutorial references for SSH key setup in documentation for a cleaner presentation. [1] [2]

Code Modernization and Cleanup:

• Removed legacy encoding comments (# -*- coding: utf-8 -*-) from all source files for modern Python compatibility. [1] [2] [3] [4] [5]
• Updated type annotations to use modern Python syntax (e.g., dict[str, Any] instead of Dict[str, Any], and union types with |) throughout src/beans_logging/_base.py for clarity and type safety. [1] [2] [3] [4] [5]
• Improved formatting and line wrapping in docstrings and error messages for better readability and consistency. [1] [2] [3]

Comment and Formatting Improvements:

• Standardized and clarified comments throughout the codebase, replacing double hashes (##) with single hashes (#), and ensuring comments accurately describe the code. [1] [2] [3] [4] [5] [6] [7]

Pre-commit and Changelog Updates:

• Commented out the local pyright hook in .pre-commit-config.yaml to avoid duplicate or unnecessary static type checking configuration.
• Removed extraneous blank lines from changelog and release notes for a cleaner look. [1] [2]

[Copilot]

Pull Request Overview

This pull request modernizes the beans-logging Python package by removing legacy encoding declarations and updating type annotations to use modern Python syntax. The changes focus on code cleanup and documentation improvements without introducing functional changes.

• Removed unnecessary UTF-8 encoding declarations from all source files
• Updated type annotations to use modern Python union syntax (e.g., str | None instead of Union[str, None])
• Improved documentation formatting and standardized comments throughout the codebase

Reviewed Changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/beans_logging/*.py	Removed UTF-8 encoding declarations and modernized type annotations
src/beans_logging/schemas.py	Updated type hints to use list[str] and improved string formatting
src/beans_logging/_base.py	Comprehensive type annotation updates and comment standardization
pyproject.toml	Updated package description from "managing logging" to "managing logs"
mkdocs.yml	Updated site description to match pyproject.toml
README.md	Fixed documentation links to use relative paths
docs/*.md	Standardized documentation links and removed video tutorial references
.pre-commit-config.yaml	Commented out local pyright hook configuration

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}