diff --git a/.gitignore b/.gitignore index 7b004e51..7b793dbb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,13 +1,26 @@ -# Byte-compiled / optimized / DLL files +# MkDocs +site/ +.mkdocs_cache/ + +# Testing +/coverage + +# Misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +# Python __pycache__/ *.py[cod] *$py.class - -# C extensions *.so - -# Distribution / packaging .Python +env/ +venv/ +ENV/ build/ develop-eggs/ dist/ @@ -20,175 +33,13 @@ parts/ sdist/ var/ wheels/ -share/python-wheels/ *.egg-info/ .installed.cfg *.egg -MANIFEST -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ -cover/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -.pybuilder/ -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -# For a library or package, you might want to ignore these files since the code is -# intended to run in multiple environments; otherwise, check them in: -# .python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# UV -# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. -# This is especially recommended for binary packages to ensure reproducibility, and is more -# commonly ignored for libraries. -#uv.lock - -# poetry -# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. -# This is especially recommended for binary packages to ensure reproducibility, and is more -# commonly ignored for libraries. -# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control -#poetry.lock - -# pdm -# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. -#pdm.lock -# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it -# in version control. -# https://pdm.fming.dev/latest/usage/project/#working-with-version-control -.pdm.toml -.pdm-python -.pdm-build/ - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ - -# pytype static type analyzer -.pytype/ - -# Cython debug symbols -cython_debug/ - -# PyCharm -# JetBrains specific template is maintained in a separate JetBrains.gitignore that can -# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore -# and can be added to the global gitignore or merged into this file. For a more nuclear -# option (not recommended) you can uncomment the following to ignore the entire idea folder. -#.idea/ - -# Abstra -# Abstra is an AI-powered process automation framework. -# Ignore directories containing user credentials, local state, and settings. -# Learn more at https://abstra.io/docs -.abstra/ - -# Visual Studio Code -# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore -# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore -# and can be added to the global gitignore or merged into this file. However, if you prefer, -# you could uncomment the following to ignore the enitre vscode folder -# .vscode/ - -# Ruff stuff: -.ruff_cache/ - -# PyPI configuration file -.pypirc - -# Cursor -# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to -# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data -# refer to https://docs.cursor.com/context/ignore-files -.cursorignore -.cursorindexingignore \ No newline at end of file +# IDE +.vscode/ +.idea/ +*.swp +*.swo +*~ diff --git a/CodeExamples.md b/docs/CodeExamples.md similarity index 100% rename from CodeExamples.md rename to docs/CodeExamples.md diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index 635b0976..00000000 --- a/docs/Gemfile +++ /dev/null @@ -1,6 +0,0 @@ -source 'https://rubygems.org' - -gem 'github-pages', group: :jekyll_plugins -gem 'jekyll-feed', '~> 0.12' -gem 'jekyll-sitemap' - diff --git a/LIBS_README.md b/docs/LIBS_README.md similarity index 100% rename from LIBS_README.md rename to docs/LIBS_README.md diff --git a/MODULES_DOCUMENTATION.md b/docs/MODULES_DOCUMENTATION.md similarity index 100% rename from MODULES_DOCUMENTATION.md rename to docs/MODULES_DOCUMENTATION.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..75fa49f5 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,114 @@ +# Semantica Documentation + +This documentation is built with [MkDocs](https://www.mkdocs.org/) - a fast, simple static site generator for project documentation. + +## Features + +- **Great themes available** - Using Material theme with beautiful design +- **Easy to customize** - Custom CSS and theme configuration +- **Preview as you work** - Built-in dev server with auto-reload +- **Host anywhere** - Static HTML that works on GitHub Pages, Netlify, etc. + +## Quick Start + +### 1. Install Dependencies + +```bash +pip install -r requirements-docs.txt +``` + +### 2. Preview Locally + +```bash +mkdocs serve +``` + +Then open `http://127.0.0.1:8000` in your browser. + +### 3. Build for Production + +```bash +mkdocs build +``` + +This creates a `site/` directory with static HTML files ready to deploy. + +## Project Structure + +``` +semantica/ +├── mkdocs.yml # MkDocs configuration +├── requirements-docs.txt # Python dependencies +├── docs/ # Documentation source files +│ ├── index.md # Homepage +│ ├── *.md # Documentation pages +│ ├── css/ +│ │ └── custom.css # Custom styling +│ └── assets/ +│ └── img/ +│ └── semantica_logo.png +└── site/ # Generated site (created by mkdocs build) +``` + +## Configuration + +Main configuration is in `mkdocs.yml`: +- Site metadata +- Theme settings (Material theme) +- Navigation structure +- Markdown extensions +- Plugins + +## Adding New Pages + +1. Create a new `.md` file in `docs/` +2. Add it to `nav:` section in `mkdocs.yml` +3. Run `mkdocs serve` to preview + +## Customization + +### Theme + +Edit `mkdocs.yml` under `theme:` section to customize: +- Color scheme +- Logo +- Features enabled +- Icons + +### Styling + +Edit `docs/css/custom.css` for custom styles. + +## Deployment + +### GitHub Pages + +```bash +mkdocs gh-deploy +``` + +### Netlify/Vercel + +1. Build: `mkdocs build` +2. Deploy the `site/` directory + +### Manual + +1. Run `mkdocs build` +2. Upload `site/` folder contents to your web server + +## Development Workflow + +1. Edit markdown files in `docs/` +2. Run `mkdocs serve` to preview +3. Changes auto-reload in browser +4. When ready, build with `mkdocs build` + +## Benefits + +- ✅ Python-based (fits with your Python project) +- ✅ Beautiful Material theme +- ✅ Fast and lightweight +- ✅ Easy to customize +- ✅ Great search functionality +- ✅ Mobile responsive diff --git a/docs/TESTING.md b/docs/TESTING.md deleted file mode 100644 index dbc2a8e7..00000000 --- a/docs/TESTING.md +++ /dev/null @@ -1,53 +0,0 @@ -# Testing Documentation Locally - -## Quick Start - -### Install Dependencies - -```bash -pip install -r requirements-docs.txt -``` - -### Run Local Server - -```bash -mkdocs serve -``` - -Then visit: `http://127.0.0.1:8000` - -### Build Static Site - -```bash -mkdocs build -``` - -Output will be in the `site/` directory. - -## Development Workflow - -1. Make changes to `.md` files in `docs/` -2. Run `mkdocs serve` to preview -3. Check changes in browser -4. Commit and push when ready - -## Troubleshooting - -### Port Already in Use - -```bash -mkdocs serve -a 127.0.0.1:8001 -``` - -### Clear Cache - -```bash -mkdocs build --clean -``` - -### Check Configuration - -```bash -mkdocs build --verbose -``` - diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 2901e587..00000000 --- a/docs/_config.yml +++ /dev/null @@ -1,21 +0,0 @@ -title: Semantica Documentation -description: Open Source Framework for Semantic Intelligence & Knowledge Engineering -theme: jekyll-theme-minimal -logo: /semantica_logo.png -show_downloads: false -github: - repository_url: https://github.com/Hawksight-AI/semantica - repository_name: Hawksight-AI/semantica - -plugins: - - jekyll-feed - - jekyll-sitemap - -# Navigation -nav: - - Home: index.md - - Installation: installation.md - - Quick Start: quickstart.md - - API Reference: api.md - - Examples: examples.md - diff --git a/docs/assets/img/semantica_logo.png b/docs/assets/img/semantica_logo.png new file mode 100644 index 00000000..7c7978e7 Binary files /dev/null and b/docs/assets/img/semantica_logo.png differ diff --git a/docs/css/custom.css b/docs/css/custom.css index cebfe4b1..2944a80a 100644 --- a/docs/css/custom.css +++ b/docs/css/custom.css @@ -1,118 +1,271 @@ -/* Custom CSS for Semantica Documentation */ +/* Semantica Documentation - Premium Green-Brown & Cream Theme */ /* Smooth scrolling */ html { scroll-behavior: smooth; } -/* Enhanced code blocks */ -.md-typeset pre > code { - border-radius: 8px; - padding: 1.2em; +/* Cream background */ +:root { + --md-default-bg-color: #FAF7F2; } -/* Custom card styles */ -.feature-card { - transition: transform 0.2s ease, box-shadow 0.2s ease; +[data-md-color-scheme="slate"] { + --md-default-bg-color: #1a1a1a; } -.feature-card:hover { - transform: translateY(-2px); - box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15); +/* Dark Green-Brown Header */ +.md-header { + background-color: #4A4F2F !important; + box-shadow: 0 2px 4px rgba(0, 0, 0, 0.15); + border-bottom: 1px solid rgba(0, 0, 0, 0.1); } -/* Diagram containers */ -.mermaid { - background: var(--md-default-bg-color); - border-radius: 8px; - padding: 1em; - margin: 1em 0; +[data-md-color-scheme="slate"] .md-header { + background-color: #4A4F2F !important; } -/* Enhanced tables */ -.md-typeset table:not([class]) { - border-radius: 8px; - overflow: hidden; +.md-header { + height: 2.4rem !important; } -/* Custom animations */ -@keyframes fadeIn { - from { - opacity: 0; - transform: translateY(10px); +.md-header__inner { + max-width: 100%; + padding: 0 1rem; + position: relative; + display: flex !important; + align-items: center !important; + justify-content: flex-start !important; + height: 2.4rem !important; +} + +/* Hamburger menu button - perfect alignment */ +.md-header__button { + display: flex !important; + align-items: center !important; + justify-content: center !important; + height: 2.4rem !important; + margin: 0 !important; + padding: 0 !important; +} + +.md-header__button--menu { + margin-right: 0.5rem !important; + width: 2.4rem !important; + height: 2.4rem !important; + display: flex !important; + align-items: center !important; + justify-content: center !important; +} + +/* "Semantica" perfectly aligned with hamburger menu */ +.md-header__title { + font-size: 1.25rem !important; + font-weight: 700 !important; + line-height: 1 !important; + margin: 0 !important; + padding: 0 !important; + margin-left: 0.5rem !important; + position: relative !important; + left: 0 !important; + transform: none !important; + display: flex !important; + align-items: center !important; + justify-content: flex-start !important; + height: 2.4rem !important; + color: #FFFFFF !important; + letter-spacing: 0.5px; + z-index: 10; +} + +.md-header__title .md-header__button { + color: #FFFFFF !important; + font-size: 1.25rem !important; + font-weight: 700 !important; + letter-spacing: 0.5px; + display: flex !important; + align-items: center !important; + height: 2.4rem !important; + line-height: 1 !important; + margin: 0 !important; + padding: 0 !important; +} + +.md-header__title span { + font-size: 1.25rem !important; + font-weight: 700 !important; + letter-spacing: 0.5px; + color: #FFFFFF !important; + display: inline-flex !important; + align-items: center !important; + line-height: 1 !important; + height: auto !important; + vertical-align: middle !important; +} + +/* Hide logo */ +.md-header__button.md-logo { + display: none !important; +} + +/* Table of Contents - Move to Left Side */ +@media screen and (min-width: 76.25em) { + .md-sidebar--primary { + width: 8rem !important; } - to { - opacity: 1; - transform: translateY(0); + + .md-sidebar--secondary { + left: 0 !important; + right: auto !important; + width: 8rem !important; + border-right: 1px solid var(--md-default-fg-color--lightest); + } + + .md-content { + margin-left: 8rem !important; + margin-right: 8rem !important; } } -.animate-fade-in { - animation: fadeIn 0.5s ease-out; +/* Ensure content uses full available width */ +.md-grid { + max-width: 100% !important; +} + +.md-content__inner { + max-width: 100% !important; + padding-left: 1rem; + padding-right: 1rem; +} + +.md-main__inner { + max-width: 100% !important; +} + +.md-container { + padding: 0; +} + +/* Reduce spacing for compact look */ +.md-content { + padding-top: 0.8rem !important; + padding-bottom: 1.2rem !important; +} + +/* Tighter headings */ +.md-typeset h1 { + margin-top: 1.5rem !important; + margin-bottom: 0.6rem !important; + font-weight: 700; } -/* Better spacing for sections */ .md-typeset h2 { - margin-top: 2em; - margin-bottom: 1em; + margin-top: 1.0rem !important; + margin-bottom: 0.4rem !important; + font-weight: 600; } .md-typeset h3 { - margin-top: 1.5em; - margin-bottom: 0.75em; + margin-top: 1.0rem !important; + margin-bottom: 0.4rem !important; + font-weight: 600; } -/* Enhanced badges */ -.badge { - display: inline-block; - padding: 0.25em 0.75em; - border-radius: 4px; - font-size: 0.85em; +.md-typeset h4 { + margin-top: 0.8rem !important; + margin-bottom: 0.3rem !important; +} + +.md-typeset p { + margin-top: 0.8em; + margin-bottom: 0.8em; + line-height: 1.7; +} + +.md-typeset ul, +.md-typeset ol { + margin-top: 0.8em; + margin-bottom: 0.8em; +} + +.md-typeset li { + margin-top: 0.4em; + margin-bottom: 0.4em; + line-height: 1.7; +} + +/* Sidebar spacing */ +.md-nav__link { + padding: 0.20rem 0.60rem !important; +} + +/* Clean TOC styling */ +.md-nav__link--active { + color: var(--md-primary-fg-color); font-weight: 500; } -/* Custom button styles */ -.md-button { +/* Better code blocks */ +.md-typeset pre { border-radius: 6px; - transition: all 0.2s ease; + background-color: #f8f6f0; } -.md-button:hover { - transform: translateY(-1px); - box-shadow: 0 2px 8px rgba(0, 0, 0, 0.15); +[data-md-color-scheme="slate"] .md-typeset pre { + background-color: #1e1e1e !important; + color: #e0e0e0 !important; } -/* Improved code copy button */ -.md-clipboard { - opacity: 0.7; - transition: opacity 0.2s ease; +[data-md-color-scheme="slate"] .md-typeset pre code { + background-color: #1e1e1e !important; + color: #e0e0e0 !important; } -.md-clipboard:hover { - opacity: 1; +[data-md-color-scheme="slate"] .md-typeset code:not(pre code) { + background-color: #2d2d2d !important; + color: #e0e0e0 !important; + padding: 0.2em 0.4em; + border-radius: 3px; } -/* Chart and diagram containers */ -.chart-container { - background: var(--md-code-bg-color); - border-radius: 8px; - padding: 1.5em; - margin: 1.5em 0; - border: 1px solid var(--md-code-hl-color); +[data-md-color-scheme="slate"] .md-typeset a { + color: #8C9464 !important; } -/* Responsive improvements */ -@media screen and (max-width: 76.1875em) { - .md-nav--primary .md-nav__title { - font-size: 1.1rem; - } +[data-md-color-scheme="slate"] .md-typeset a:hover { + color: #a8b080 !important; } -/* Print styles */ -@media print { - .md-sidebar, - .md-header { - display: none; - } +[data-md-color-scheme="slate"] .md-typeset { + color: rgba(255, 255, 255, 0.87) !important; } +[data-md-color-scheme="slate"] .md-typeset p { + color: rgba(255, 255, 255, 0.87) !important; +} + +[data-md-color-scheme="slate"] .md-typeset li { + color: rgba(255, 255, 255, 0.87) !important; +} + +[data-md-color-scheme="slate"] .md-typeset table:not([class]) { + border-color: rgba(255, 255, 255, 0.12) !important; +} + +[data-md-color-scheme="slate"] .md-typeset table:not([class]) th { + background-color: rgba(255, 255, 255, 0.05) !important; + color: rgba(255, 255, 255, 0.87) !important; +} + +[data-md-color-scheme="slate"] .md-typeset table:not([class]) td { + color: rgba(255, 255, 255, 0.87) !important; +} + +/* Accent color for links */ +.md-typeset a { + color: #4A4F2F; +} + +.md-typeset a:hover { + color: #8C9464; +} diff --git a/docs/index.md b/docs/index.md index 6f30ef62..24d5de1e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,13 @@ # Welcome to Semantica +
+ Semantica Logo +
+ **Transform chaotic data into intelligent knowledge.** Semantica is an open-source framework for building semantic layers and knowledge graphs that power the next generation of AI applications. ---- - ## 🚀 Get Started in 60 Seconds ```python @@ -18,42 +20,38 @@ print(f"Extracted {len(result['knowledge_graph']['entities'])} entities") **Install:** `pip install semantica` ---- - ## Choose Your Learning Path -=== "⚡ Quick Start (5 min)" +### ⚡ Quick Start (5 min) - **Perfect for:** Trying Semantica quickly - - ```bash - pip install semantica - ``` - - → **[Quickstart Guide](quickstart.md)** - Build your first knowledge graph - - → **[Examples](examples.md)** - See what's possible +**Perfect for:** Trying Semantica quickly -=== "📚 Complete Guide (30 min)" +```bash +pip install semantica +``` - **Perfect for:** Learning properly - - 1. **[Installation](installation.md)** - Complete setup - 2. **[Quickstart](quickstart.md)** - Step-by-step tutorial - 3. **[Examples](examples.md)** - Real-world use cases - 4. **[API References](api.md)** - Full documentation +→ **[Quickstart Guide](quickstart.md)** - Build your first knowledge graph -=== "🎓 Interactive Learning" +→ **[Examples](examples.md)** - See what's possible - **Perfect for:** Hands-on learners - - → **[Cookbook Recipes](cookbook.md)** - Interactive Jupyter notebooks - - - Introduction tutorials - - Advanced techniques - - Domain-specific use cases +### 📚 Complete Guide (30 min) ---- +**Perfect for:** Learning properly + +1. **[Installation](installation.md)** - Complete setup +2. **[Quickstart](quickstart.md)** - Step-by-step tutorial +3. **[Examples](examples.md)** - Real-world use cases +4. **[API References](api.md)** - Full documentation + +### 🎓 Interactive Learning + +**Perfect for:** Hands-on learners + +→ **[Cookbook Recipes](cookbook.md)** - Interactive Jupyter notebooks + +- Introduction tutorials +- Advanced techniques +- Domain-specific use cases ## What Can You Build? @@ -69,342 +67,37 @@ Power enhanced RAG systems with knowledge graphs for better context understandin ### AI Agent Memory Provide AI agents with persistent, structured memory using knowledge graphs. ---- - -## Features { #features } - -Comprehensive capabilities for semantic intelligence and knowledge engineering. +## Features ### 🎯 Entity & Relationship Extraction - Extract entities and relationships from unstructured text using advanced NLP. -```python -from semantica import Semantica - -semantica = Semantica() -entities = semantica.semantic_extract.extract_entities(text) -relationships = semantica.semantic_extract.extract_relationships(text) -``` - -**Capabilities:** -- Named Entity Recognition (NER) -- Relationship extraction -- Triple extraction (subject-predicate-object) -- Coreference resolution -- Event detection - ### 🔗 Knowledge Graph Construction - Build comprehensive knowledge graphs from multiple data sources. -```python -result = semantica.build_knowledge_base([ - "document1.pdf", - "document2.docx", - "https://example.com/article" -]) - -kg = result["knowledge_graph"] -``` - -**Features:** -- Multi-source integration -- Automatic relationship discovery -- Graph validation -- Quality assurance -- Incremental building - ### ⚖️ Conflict Resolution - Automatically resolve conflicts when the same entity appears in multiple sources. -```python -from semantica.conflicts import ConflictResolver - -resolver = ConflictResolver(default_strategy="voting") -resolved = resolver.resolve_conflicts(conflicts) -``` - -**Strategies:** -- Voting (majority wins) -- Credibility weighted -- Most recent -- Highest confidence -- First seen -- Manual review - ### 📤 Multiple Export Formats - Export to RDF, OWL, JSON, CSV, YAML, and more. -```python -semantica.export.to_rdf(kg, "output.rdf") -semantica.export.to_json(kg, "output.json") -semantica.export.to_owl(kg, "output.owl") -semantica.export.to_csv(kg, "output.csv") -``` - -**Supported Formats:** -- RDF/XML -- OWL (Web Ontology Language) -- JSON-LD -- CSV -- YAML -- GraphML -- Neo4j Cypher - ### 🧠 Embedding Generation - Generate embeddings for text, images, and audio. -```python -embeddings = semantica.embeddings.generate(text) -graph_embeddings = semantica.embeddings.generate_graph_embeddings(kg) -``` - -**Capabilities:** -- Text embeddings -- Graph embeddings -- Multimodal embeddings -- Batch processing -- Custom models - ### 🔍 Vector Store Integration +Store and query embeddings efficiently with support for multiple vector stores. -Store and query embeddings efficiently. - -```python -semantica.vector_store.add(embeddings, metadata) -results = semantica.vector_store.search(query, top_k=10) -``` - -**Supported Stores:** -- FAISS -- Pinecone -- Weaviate -- Qdrant -- Milvus - -### 📊 Data Ingestion - -Support for multiple data sources and formats. - -```python -# From files -sources = ["document.pdf", "data.json", "report.docx"] - -# From URLs -sources = ["https://example.com/article"] - -# From databases -sources = ["postgresql://localhost/db"] -``` - -**Supported Sources:** -- Files (PDF, DOCX, HTML, JSON, CSV, etc.) -- URLs and web content -- Databases (SQL, NoSQL) -- APIs and feeds -- Real-time streams - -### 🎨 Visualization - -Visualize knowledge graphs interactively. - -```python -semantica.kg.visualize(kg, output_path="graph.html") -``` - -**Features:** -- Interactive graphs -- Custom layouts -- Export to images -- Web-based viewer - ---- - -## How to Read this Documentation { #how-to-read } - -This documentation is organized to help you find what you need quickly. - -### Navigation Structure - -**Left Sidebar (Main Navigation):** -- **Home** - This page, overview and quick start -- **Quickstart** - Get started in 5 minutes -- **Installation** - Setup and configuration -- **Cookbook Recipes** - Interactive Jupyter notebooks -- **Learning More** - Additional resources and tutorials -- **Deep Dive** - Advanced topics and architecture -- **API References** - Complete API documentation - -**Right Sidebar (Table of Contents):** -- Appears on each page -- Shows page structure -- Quick navigation to sections -- Auto-generated from headings - -### Reading Paths - -**For Beginners:** -1. Start with [Quickstart](quickstart.md) -2. Follow [Installation](installation.md) -3. Try [Cookbook Recipes](cookbook.md) - Introduction section -4. Explore [Examples](examples.md) - -**For Experienced Users:** -1. Review [API References](api.md) -2. Check [Deep Dive](deep-dive.md) for architecture -3. Explore [Cookbook Recipes](cookbook.md) - Advanced section -4. See [Learning More](learning-more.md) for best practices - -**For Researchers:** -1. Read [Citation](citation.md) information -2. Check [Deep Dive](deep-dive.md) for technical details -3. Review [Community Projects](community-projects.md) -4. See [License](license.md) for usage rights - -### Using Code Examples - -All code examples are: -- ✅ Tested and working -- ✅ Copyable with one click -- ✅ Include expected outputs -- ✅ Contextual explanations - -### Interactive Elements - -- **Tabs**: Switch between different options -- **Diagrams**: Mermaid diagrams for visual understanding -- **Code Blocks**: Syntax highlighted, copyable -- **Search**: Find content quickly -- **Dark/Light Mode**: Toggle theme - ---- - -## Resources { #resources } - -Essential links and resources for Semantica. - -### Official Resources - -- **GitHub Repository**: [github.com/Hawksight-AI/semantica](https://github.com/Hawksight-AI/semantica) - - Source code - - Issue tracking - - Discussions - - Contributions - -- **PyPI Package**: [pypi.org/project/semantica](https://pypi.org/project/semantica) - - Package downloads - - Version history - - Installation instructions +## Resources +- **GitHub**: [github.com/Hawksight-AI/semantica](https://github.com/Hawksight-AI/semantica) +- **PyPI**: [pypi.org/project/semantica](https://pypi.org/project/semantica) - **Documentation**: This site - - Complete guides - - API reference - - Examples and tutorials - -### Community Resources - -- **GitHub Discussions**: [Discussions](https://github.com/Hawksight-AI/semantica/discussions) - - Ask questions - - Share ideas - - Show your projects - -- **GitHub Issues**: [Issues](https://github.com/Hawksight-AI/semantica/issues) - - Report bugs - - Request features - - Get help - -- **Community Projects**: [Community Projects](community-projects.md) - - See what others are building - - Share your project - -### Additional Resources - -- **Citation**: [How to cite Semantica](citation.md) -- **License**: [MIT License details](license.md) -- **Contributing**: [How to contribute](https://github.com/Hawksight-AI/semantica/blob/main/CONTRIBUTING.md) - ---- - -## Common Use Cases - -### Research & Analysis -- Extract knowledge from research papers -- Build domain-specific knowledge graphs -- Analyze relationships in literature - -### Business Intelligence -- Process company documents -- Build organizational knowledge bases -- Integrate multiple data sources - -### AI Applications -- Power GraphRAG systems -- Enhance AI agent memory -- Build semantic search systems - ---- - -## Quick Links - -
- -- :material-speedometer:{ .lg .middle } __Quickstart__ - - --- - - Get up and running in 5 minutes - - [:octicons-arrow-right-24: Quickstart Guide](quickstart.md) - -- :material-book-open-variant:{ .lg .middle } __Examples__ - - --- - - See real-world use cases and code examples - - [:octicons-arrow-right-24: Browse Examples](examples.md) - -- :material-notebook:{ .lg .middle } __Cookbook__ - - --- - - Interactive Jupyter notebooks for hands-on learning - - [:octicons-arrow-right-24: Explore Cookbook](cookbook.md) - -- :material-api:{ .lg .middle } __API Reference__ - - --- - - Complete API documentation - - [:octicons-arrow-right-24: View API Docs](api.md) - -
- ---- - -## Installation - -```bash -pip install semantica -``` - -See the [Installation Guide](installation.md) for detailed instructions, optional dependencies, and troubleshooting. - ---- ## Need Help? -- **First time?** → [Quickstart](quickstart.md) -- **Installation issues?** → [Installation Guide](installation.md#troubleshooting) +- **First time?** → [Getting Started](getting-started) +- **Installation issues?** → [Installation Guide](installation) - **Questions?** → [GitHub Discussions](https://github.com/Hawksight-AI/semantica/discussions) - **Found a bug?** → [GitHub Issues](https://github.com/Hawksight-AI/semantica/issues) ---- - -**Ready to transform your data?** Start with the [Quickstart Guide](quickstart.md) or explore the [Cookbook Recipes](cookbook.md) for interactive tutorials. +**Ready to transform your data?** Start with the [Getting Started Guide](getting-started) or explore the [Cookbook Recipes](cookbook) for interactive tutorials. diff --git a/docs/netlify.toml b/docs/netlify.toml index 764f0cfb..ed2871b0 100644 --- a/docs/netlify.toml +++ b/docs/netlify.toml @@ -1,9 +1,9 @@ [build] - command = "cd docs && bundle install && bundle exec jekyll build -d ../_site" - publish = "_site" + command = "pip install -r requirements-docs.txt && mkdocs build" + publish = "site" [build.environment] - RUBY_VERSION = "3.1" + PYTHON_VERSION = "3.11" [[redirects]] from = "/*" diff --git a/docs/preview.html b/docs/preview.html deleted file mode 100644 index 14784e6c..00000000 --- a/docs/preview.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - - Semantica Documentation - - - -
-
-

🧠 Semantica

-

Open Source Framework for Semantic Intelligence & Knowledge Engineering

-

Transform chaotic data into intelligent knowledge.

-
- Python 3.8+ - MIT License - PyPI - Open Source -
-
- -
-
-

🚀 Quick Start

-

Installation

-
- pip install semantica -
- -

Basic Usage

-
- from semantica import Semantica

-# Initialize Semantica
-semantica = Semantica()

-# Build knowledge graph from data
-result = semantica.build_knowledge_base(
-    sources=["document.pdf", "data.json"],
-    embeddings=True,
-    graph=True
-)

-# Access the knowledge graph
-kg = result["knowledge_graph"]
-print(f"Entities: {len(kg['entities'])}")
-print(f"Relationships: {len(kg['relationships'])}") -
-
- -
-

📚 Documentation

-
- Installation Guide - Quick Start - Core Features - Examples - API Reference -
-
- -
-

✨ Core Features

-
-
- Semantic Layer Construction - Build semantic layers from unstructured data -
-
- Knowledge Graph Generation - Create and manage knowledge graphs -
-
- Entity & Relationship Extraction - Extract entities and relationships from text -
-
- Conflict Resolution - Multiple strategies for resolving data conflicts -
-
- Multiple Export Formats - Export to RDF, OWL, JSON, CSV, YAML, and more -
-
- Vector Store Integration - Store and query embeddings -
-
-
- -
-

📖 Learn More

- -
-
- - -
- - - diff --git a/docs/vercel.json b/docs/vercel.json deleted file mode 100644 index e3274d33..00000000 --- a/docs/vercel.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "buildCommand": "cd docs && bundle install && bundle exec jekyll build -d ../_site", - "outputDirectory": "_site", - "framework": null, - "rewrites": [ - { - "source": "/(.*)", - "destination": "/index.html" - } - ] -} - diff --git a/mkdocs.yml b/mkdocs.yml index 844d9425..e0b8c0f7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,15 +14,15 @@ theme: palette: # Light mode - scheme: default - primary: indigo - accent: indigo + primary: "#4A4F2F" + accent: "#8C9464" toggle: icon: material/brightness-7 name: Switch to dark mode # Dark mode - scheme: slate - primary: indigo - accent: indigo + primary: "#4A4F2F" + accent: "#8C9464" toggle: icon: material/brightness-4 name: Switch to light mode @@ -84,12 +84,23 @@ extra_css: # Navigation nav: - Home: index.md - - Quickstart: quickstart.md - - Installation: installation.md - - Cookbook Recipes: cookbook.md - - Learning More: learning-more.md - - Deep Dive: deep-dive.md - - API References: api.md + - Getting Started: + - getting-started.md + - installation.md + - quickstart.md + - Guides: + - concepts.md + - examples.md + - cookbook.md + - learning-more.md + - Advanced: + - deep-dive.md + - api.md + - Resources: + - community-projects.md + - citation.md + - faq.md + - license.md # Extra extra: diff --git a/netlify.toml b/netlify.toml deleted file mode 100644 index ed2871b0..00000000 --- a/netlify.toml +++ /dev/null @@ -1,12 +0,0 @@ -[build] - command = "pip install -r requirements-docs.txt && mkdocs build" - publish = "site" - -[build.environment] - PYTHON_VERSION = "3.11" - -[[redirects]] - from = "/*" - to = "/index.html" - status = 200 -