V0.1.0 introducs v0.1.0 with breaking changes, semantic improvements, and testing refactor

.coveragerc

@@ -12,5 +12,3 @@ omit =
     examples/*
     docs/*
     */__init__.py
-
-

.pre-commit-config.yaml

@@ -27,14 +27,14 @@ repos:
       - id: isort
         args: ["--profile", "black"]
 
-  # MyPy - Type checking
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.18.2
-    hooks:
-      - id: mypy
-        additional_dependencies: []
-        args: [--ignore-missing-imports]
-        files: ^(fynx|tests)/
+  # MyPy - Type checking, disabled for now
+  # - repo: https://github.com/pre-commit/mirrors-mypy
+  #   rev: v1.18.2
+  #   hooks:
+  #     - id: mypy
+  #       additional_dependencies: []
+  #       args: [--ignore-missing-imports]
+  #       files: ^(fynx|tests)/
 
   # General pre-commit hooks
   - repo: https://github.com/pre-commit/pre-commit-hooks

docs/README.md

@@ -9,12 +9,14 @@ docs/
 ├── README.md                    # This file
 ├── index.md                     # Main landing page (MkDocs compatible)
 ├── generation/                  # Documentation generation files
-│   ├── mkdocs.yml               # MkDocs configuration
-│   ├── markdown/                # Generated markdown documentation
-│   │   └── api.md               # API reference (processed by mkdocstrings)
+│   ├── markdown/                # Documentation source files
+│   │   ├── mkdocs.yml           # MkDocs configuration
+│   │   ├── tutorial/            # Tutorial content
+│   │   ├── reference/           # API reference documentation
+│   │   └── mathematical/        # Mathematical foundations
 │   └── scripts/                 # Documentation generation scripts
 │       ├── generate_html.py     # HTML documentation generator
-│       └── preview_docs.sh      # Preview server launcher
+│       └── preview_html_docs.sh # Preview server launcher
 ├── images/                      # Universal images and assets
 │   ├── banner.svg               # Main logo/banner for documentation
 │   ├── fynx_icon.svg            # Icon for favicons and logos
@@ -34,14 +36,14 @@ python docs/generation/scripts/generate_html.py
 ### Previewing Documentation
 
 ```bash
-bash docs/generation/scripts/preview_docs.sh
+bash docs/generation/scripts/preview_html_docs.sh
 ```
 
 This will:
 1. Build HTML documentation using MkDocs with mkdocstrings
-2. Output to the `site/` directory
+2. Start a local development server at http://localhost:8000
 
 ### Adding New Pages
 
-1. Create markdown files directly in the `docs/` directory
-2. Add entries to the `nav` section in `docs/build/mkdocs.yml`
+1. Create markdown files in the appropriate subdirectory (`tutorial/`, `reference/`, or `mathematical/`)
+2. Add entries to the `nav` section in `docs/generation/markdown/mkdocs.yml`

docs/javascripts/mathjax.js → docs/generation/markdown/assets/javascripts/mathjax.js

@@ -13,4 +13,4 @@ window.MathJax = {
 
 document$.subscribe(() => {
   MathJax.typesetPromise?.();  // ensure Promise exists to avoid type errors
-});
+});