initialize Retype project and add initial core documentation

Author: Endkind

.github/workflows/retyoe-action.yml

@@ -0,0 +1,21 @@
+name: Publish Retype powered website to GitHub Pages
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: retypeapp/action-build@latest
+
+      - uses: retypeapp/action-github-pages@latest
+        with:
+          update-branch: true

.gitignore

@@ -1 +1,136 @@
-.venv
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# vitepress build output
+**/.vitepress/dist
+
+# vitepress cache directory
+**/.vitepress/cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+---
+date: 2025-06-21
+category: [core]
+tags: [BaseConfig, config, ClassVar]
+description: Base configuration class for ModuBotCore
+
+author:
+  - name: Endkind
+    link: https://github.com/Endkind
+    avatar: https://github.com/Endkind.png
+---
+
+# BaseConfig
+
+`BaseConfig` is the base class for all configuration classes in ModuBotCore. It provides automatic runtime type checking for class variables (`ClassVar`).
+
+When you create a subclass of `BaseConfig`, all `ClassVar` attributes are validated to ensure their types match the declared types. This helps catch configuration errors early.
+
+## Supported Types
+
+- Primitive types: `str`, `int`, `float`, `bool`
+- Type wrappers, e.g., `Type[SomeClass]`
+
+If a `ClassVar` has an invalid or unsupported value/type, a `TypeError` is raised at class creation time.
+
+## Example
+
+```python
+from typing import ClassVar
+from ModuBotCore.config import BaseConfig
+
+class MyConfig(BaseConfig):
+    NAME: ClassVar[str] = "MyBot"
+    ENABLE_FEATURE: ClassVar[bool] = True
+    TIMEOUT: ClassVar[int] = 30
+```
+
+If you assign a wrong type, e.g. `NAME: ClassVar[str] = 123`, a `TypeError` will be raised immediately.
+
+This ensures your configuration is always type-safe.

core/config/base.md

@@ -0,0 +1 @@
+icon: gear

core/config/index.yml

@@ -0,0 +1,37 @@
+---
+date: 2025-06-21
+category: [core]
+tags: [logger, config, BaseConfig]
+description: Logger configuration for ModuBotCore
+
+author:
+  - name: Endkind
+    link: https://github.com/Endkind
+    avatar: https://github.com/Endkind.png
+---
+
+# Logger Configuration
+
+ModuBotCore provides a ready-to-use logger configuration via the `LoggerConfig` class.
+
+## LoggerConfig
+
+`LoggerConfig` inherits from `BaseConfig` and is a frozen dataclass. It defines the following class variables:
+
+- `LEVEL`: Logging level (e.g., DEBUG, INFO). Defaults to the `LOG_LEVEL` environment variable or `'INFO'`.
+- `FORMAT`: Format string for log messages. Default: `"[%(asctime)s - %(levelname)s - %(name)s]: %(message)s"`
+- `DATEFMT`: Format string for timestamps in log messages. Default: `"%m/%d/%Y %H:%M:%S"`
+
+You can use or override these settings in your own configuration if needed.
+
+## Example
+
+```python
+from ModuBotCore.config import LoggerConfig
+
+print(LoggerConfig.LEVEL)    # e.g., 'INFO'
+print(LoggerConfig.FORMAT)   # e.g., '[%(asctime)s - %(levelname)s - %(name)s]: %(message)s'
+print(LoggerConfig.DATEFMT)  # e.g., '%m/%d/%Y %H:%M:%S'
+```
+
+These settings control the log output format and level for all logging in ModuBotCore.

core/config/logger.md

@@ -0,0 +1,56 @@
+---
+date: 2025-06-21
+category: [core]
+tags: [core, ModuBotCore, customization]
+description: Usage and customization of ModuBotCore
+
+author:
+  - name: Endkind
+    link: https://github.com/Endkind
+    avatar: https://github.com/Endkind.png
+---
+
+# ModuBotCore Usage
+
+You can use the default core directly:
+
+```python
+from ModuBotCore import ModuBotCore
+
+ModuBotCore().run()
+```
+
+Or you can customize it by creating your own class that inherits from `ModuBotCore`.
+
+You have access to the logger via `self.logger`.
+
+To start and stop the bot, use the `run()` and `stop()` methods.
+
+## Important ClassVars
+
+```python
+NAME: ClassVar[str] = "ModuBotCore"
+VERSION: ClassVar[str] = "0.0.1"
+LOGGER_CONFIG: ClassVar[Type[LoggerConfig]] = LoggerConfig
+MODULE_BASE_CLASS: ClassVar[Type[BaseModule]] = BaseModule
+```
+
+## Example: Custom Core
+
+```python
+from ModuBotCore import ModuBotCore
+from ModuBotCore.config import LoggerConfig
+
+class MyLoggerConfig(LoggerConfig):
+    LEVEL = "DEBUG"
+
+class MyBot(ModuBotCore):
+    NAME = "MyCustomBot"
+    VERSION = "1.2.3"
+    LOGGER_CONFIG = MyLoggerConfig
+
+bot = MyBot()
+bot.run()
+```
+
+This allows you to extend and modify the core functionality as needed.

core/core.md

@@ -0,0 +1,30 @@
+---
+date: 2025-06-21
+category: [core]
+tags: [helpers, str2bool]
+description: Overview of helpers in ModuBotCore
+
+author:
+  - name: Endkind
+    link: https://github.com/Endkind
+    avatar: https://github.com/Endkind.png
+---
+
+# Helpers
+
+ModuBotCore provides useful helper functions in `ModuBotCore.helpers`.
+
+## str2bool
+
+`str2bool(value: str) -> bool`
+
+Converts a string to a boolean value. Useful for parsing configuration values or user input.
+
+### Example
+
+```python
+from ModuBotCore.helpers import str2bool
+
+print(str2bool("true"))   # True
+print(str2bool("False"))  # False
+```

core/helpers.md

@@ -0,0 +1,31 @@
+---
+date: 2025-06-21
+category: [core]
+description: Overview of the ModuBotCore core features
+icon: heart
+
+author:
+  - name: Endkind
+    link: https://github.com/Endkind
+    avatar: https://github.com/Endkind.png
+---
+
+# Core
+
+This documentation covers the **core** of the ModuBot project. The core is provided as the Python package `ModuBotCore` and forms the foundation for building modular and extensible bots with ModuBot.
+
+- Use the default core out of the box or extend it with your own classes.
+- Built-in configuration system with type checking.
+- Flexible logger configuration.
+- Easy module integration and management.
+
+You can start ModuBotCore directly or customize its behavior by subclassing and overriding configuration options.
+
+For more details, see:
+
+- [Installation](./install.md)
+- [Core Usage](./core.md)
+- [Module System](./module.md)
+- [Helpers](./helpers.md)
+- [Base Configuration](./config/base.md)
+- [Logger Configuration](./config/logger.md)