new project structure

.env.example

@@ -0,0 +1,9 @@
+# OpenAI API Key (Required for main functionality)
+OPENAI_API_KEY=
+
+# Optional: Other providers generally supported by similar libs, 
+# but PageIndex currently defaults to OpenAI/tiktoken.
+ANTHROPIC_API_KEY=
+GOOGLE_API_KEY=
+MISTRAL_API_KEY=
+OPENROUTER_API_KEY=

.gitignore

@@ -1,15 +1,52 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual Environment
+venv/
+env/
+ENV/
+.env
+
+# Jupyter Notebooks
 .ipynb_checkpoints
-__pycache__
-files
-index
-temp/*
+*/.ipynb_checkpoints/*
+profile_default/
+ipython_config.py
+
+# MacOS
+.DS_Store
+
+# Logs
+logs/
+*.log
+
+# Project specific
+files/
+index/
 chroma-collections.parquet
 chroma-embeddings.parquet
-.DS_Store
-.env*
-notebook
+temp/*
+notebook/
 SDK/*
-log/*
-logs/
 parts/*
 json_results/*

CHANGELOG.md

@@ -1,16 +1,35 @@
-# Change Log
-All notable changes to this project will be documented in this file.
+# Журнал изменений
 
-## Beta - 2025-04-23
+Все заметные изменения проекта будут документироваться в этом файле.
 
-### Fixed
-- [x] Fixed a bug introduced on April 18 where `start_index` was incorrectly passed.
+## [0.1.0] - 2026-01-27
 
-## Beta - 2025-04-03
+### Добавлено
 
-### Added
-- [x] Add node_id, node summary
-- [x] Add document discription
+- Модульная архитектура: разделение `utils.py` на `core/llm.py`, `core/pdf.py`, `core/tree.py`.
+- Pydantic для валидации конфигурации (`src/pageindex/config.py`).
+- Типизация (Type hints) и docstrings для всех ключевых модулей.
+- Тесты (`pytest`) для покрытия основного функционала.
+- `API_REFERENCE.md` и обновленный Developer Guide в `README.md`.
 
-### Changed
-- [x] Change "child_nodes" -> "nodes" to simplify the structure
+### Изменено
+
+- `config.yaml` теперь использует булевы значения (`true`/`false`) вместо строк "yes"/"no".
+- `utils.py` оставлен как фасад для обратной совместимости.
+
+## Бета - 2025-04-23
+
+### Исправлено
+
+- [x] Исправлена ошибка, появившаяся 18 апреля: `start_index` передавался неверно.
+
+## Бета - 2025-04-03
+
+### Добавлено
+
+- [x] Добавлены node_id и резюме узла
+- [x] Добавлено описание документа
+
+### Изменено
+
+- [x] `child_nodes` -> `nodes` для упрощения структуры

pageindex/config.yaml → config.yaml

@@ -2,7 +2,7 @@ model: "gpt-4o-2024-11-20"
 toc_check_page_num: 20
 max_page_num_each_node: 10
 max_token_num_each_node: 20000
-if_add_node_id: "yes"
-if_add_node_summary: "yes"
-if_add_doc_description: "no"
-if_add_node_text: "no"
+if_add_node_id: true
+if_add_node_summary: true
+if_add_doc_description: false
+if_add_node_text: false