mirror of
https://github.com/semantica-agi/semantica.git
synced 2026-08-29 04:26:20 +00:00
KaifAhmad1
d3b579208c
## Documentation Changes ### 📚 Major Improvements - **Cleaned up all documentation files** - Removed redundant content and improved clarity - **Restructured Resources section** - Removed unnecessary files, kept only essential ones - **Added Snowflake integration** - Complete integration guide with examples - **Improved navigation** - Better organization and user experience ### 🗂️ File Changes - **docs/concepts.md** - Rewritten to be clean and user-friendly - **docs/modules.md** - Updated with current modules and removed emojis - **docs/glossary.md** - Reorganized thematically instead of alphabetically - **docs/getting-started.md** - Made more concise and practical - **docs/community.md** - Clean, focused community guide - **docs/contributing.md** - Clear contribution guidelines - **docs/faq.md** - Comprehensive FAQ with practical answers - **docs/license.md** - Clean license explanation - **docs/css/custom.css** - Fixed CSS syntax and organization ### 🔧 Technical Changes - **mkdocs.yml** - Updated navigation, removed redundant files - **docs/integrations/snowflake.md** - New comprehensive Snowflake guide - **docs/reference/ingest.md** - Added Snowflake references - **Removed files**: changelog.md, release-guide.md, change_management_usage.md, community-projects.md, architecture.md, governance.md, citation.md ### 🎯 Benefits - **Better user experience** - Clean, easy to navigate documentation - **Reduced redundancy** - No duplicate or unnecessary content - **Professional quality** - Enterprise-ready documentation - **Consistent style** - Uniform formatting across all files This commit includes all documentation improvements while maintaining the main branch's stability.
161 lines
3.9 KiB
YAML
161 lines
3.9 KiB
YAML
# Deployment Trigger: Public GitHub Pages
|
|
site_name: Semantica
|
|
site_description: Open Source Framework for Semantic Intelligence & Knowledge Engineering
|
|
site_url: https://hawksight-ai.github.io/semantica/
|
|
repo_url: https://github.com/Hawksight-AI/semantica
|
|
repo_name: Hawksight-AI/semantica
|
|
edit_uri: edit/main/docs/
|
|
|
|
# Copyright
|
|
copyright: Copyright © 2026 Hawksight AI
|
|
|
|
# Theme Configuration
|
|
theme:
|
|
name: material
|
|
palette:
|
|
# Light mode
|
|
- scheme: default
|
|
primary: custom
|
|
accent: custom
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
# Dark mode
|
|
- scheme: slate
|
|
primary: custom
|
|
accent: custom
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.top
|
|
- navigation.indexes
|
|
- navigation.tracking
|
|
- search.suggest
|
|
- search.highlight
|
|
- search.share
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
- content.tooltips
|
|
icon:
|
|
logo: material/brain
|
|
repo: fontawesome/brands/github
|
|
|
|
# Extensions
|
|
markdown_extensions:
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets:
|
|
base_path: ["."]
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- admonition
|
|
- pymdownx.details
|
|
- attr_list
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
toc_depth: 6
|
|
|
|
# Plugins
|
|
plugins:
|
|
- search:
|
|
lang: en
|
|
- minify:
|
|
minify_html: true
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
options:
|
|
docstring_style: google
|
|
show_source: true
|
|
show_root_heading: true
|
|
show_category_heading: true
|
|
- mkdocs-jupyter:
|
|
include_source: true
|
|
|
|
# Custom CSS
|
|
extra_css:
|
|
- css/custom.css
|
|
|
|
# Custom JavaScript
|
|
extra_javascript: []
|
|
|
|
# Navigation
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- Overview: getting-started.md
|
|
- installation.md
|
|
- quickstart.md
|
|
- Docs:
|
|
- Change Management: reference/change_management.md
|
|
- Conflicts: reference/conflicts.md
|
|
- Context: reference/context.md
|
|
- Core: reference/core.md
|
|
- Deduplication: reference/deduplication.md
|
|
- Embeddings: reference/embeddings.md
|
|
- Evals: reference/evals.md
|
|
- Export: reference/export.md
|
|
- Graph Store: reference/graph_store.md
|
|
- Ingest: reference/ingest.md
|
|
- Knowledge Graph: reference/kg.md
|
|
- LLMs: reference/llms.md
|
|
- Normalize: reference/normalize.md
|
|
- Ontology: reference/ontology.md
|
|
- Parse: reference/parse.md
|
|
- Pipeline: reference/pipeline.md
|
|
- Provenance: reference/provenance.md
|
|
- Reasoning: reference/reasoning.md
|
|
- Seed: reference/seed.md
|
|
- Semantic Extract: reference/semantic_extract.md
|
|
- Split: reference/split.md
|
|
- Triplet Store: reference/triplet_store.md
|
|
- Utils: reference/utils.md
|
|
- Vector Store: reference/vector_store.md
|
|
- Visualization: reference/visualization.md
|
|
- Guides:
|
|
- concepts.md
|
|
- modules.md
|
|
- use-cases.md
|
|
- examples.md
|
|
- glossary.md
|
|
- Integrations:
|
|
- Docling: integrations/docling.md
|
|
- Snowflake: integrations/snowflake.md
|
|
- Cookbook: cookbook.md
|
|
- Resources:
|
|
- community.md
|
|
- contributing.md
|
|
- faq.md
|
|
- license.md
|
|
|
|
# Extra
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/Hawksight-AI/semantica
|
|
- icon: fontawesome/brands/python
|
|
link: https://pypi.org/project/semantica/
|
|
version:
|
|
provider: mike
|
|
generator: true
|
|
|