mengzhx/semantica
1
0
Fork 0
mirror of https://github.com/semantica-agi/semantica.git synced 2026-08-29 04:26:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: refine onboarding guidance and reduce duplication

Browse Source
This commit is contained in:
Sameer6305
2026-05-22 23:27:11 +05:30
parent a43cb07017
commit b09d60161d
4 changed files with 18 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started.md
+2 -6
View File
@@ -5,7 +5,7 @@ icon: "rocket"
---
<Tip>
Just here for code? Jump straight to the [Quickstart Tutorial](quickstart) or explore the [Cookbook](cookbook) for interactive notebooks.
Already installed? Jump to the [Quickstart Tutorial](quickstart). Need setup help first? Start with [Installation](installation).
</Tip>
---
@@ -35,11 +35,7 @@ icon: "rocket"
pip install semantica
```
With all optional dependencies:
```bash
pip install semantica[all]
```
For virtual environments, extras, and platform-specific setup, see the full [Installation guide](installation).
Verify:
docs/index.md
+5 -3
View File
@@ -181,18 +181,20 @@ pip install semantica==0.5.0
## Start Here
If you're new to Semantica, install first and then open Quickstart. Use Core Concepts or API Reference when you need more context or exact details.
<CardGroup cols={2}>
<Card title="Quickstart" icon="rocket" href="quickstart">
Build a complete knowledge graph pipeline in 5 minutes.
</Card>
<Card title="Core Concepts" icon="book-open" href="concepts">
Knowledge graphs, ontologies, and semantic reasoning explained.
Use this for the mental model behind the API.
</Card>
<Card title="API Reference" icon="rectangle-terminal" href="reference/context">
Full documentation for every module, class, and method.
Jump here when you need exact module, class, or method details.
</Card>
<Card title="Cookbook" icon="flask" href="cookbook">
40+ domain-specific notebooks — healthcare, finance, legal, and more.
Explore domain notebooks once you have the basics working.
</Card>
</CardGroup>
docs/installation.md
+10 -6
View File
@@ -12,6 +12,10 @@ icon: "download"
Python 3.8 or higher required. Python 3.11+ recommended.
</Note>
<Tip>
Once you're set up, read [Getting Started](getting-started) for the overview and [Quickstart](quickstart) for the end-to-end pipeline.
</Tip>
---
## Basic Installation
@@ -177,13 +181,13 @@ Install the [Microsoft Visual C++ Redistributable](https://aka.ms/vs/17/release/
## Next Steps
<CardGroup cols={3}>
<Card title="Getting Started" icon="rocket" href="getting-started">
Build your first knowledge graph.
<Card title="Read the Overview" icon="rocket" href="getting-started">
Understand what Semantica does before you build.
</Card>
<Card title="Quickstart Tutorial" icon="play" href="quickstart">
Full step-by-step pipeline.
<Card title="Build the Pipeline" icon="play" href="quickstart">
Follow the end-to-end workflow with code.
</Card>
<Card title="Cookbook" icon="flask" href="cookbook">
Interactive Jupyter notebooks.
<Card title="Browse Examples" icon="flask" href="cookbook">
See notebook examples organized by use case.
</Card>
</CardGroup>
docs/quickstart.md
+1 -1
View File
@@ -8,7 +8,7 @@ icon: "rocket"
**v0.5.0** — Ontology Hub, Distance Intelligence, Parquet & XML ingestion, 12 security fixes. [What's new →](index#whats-new)
</Info>
This guide walks you through a complete Semantica pipeline — from raw document to queryable knowledge graph with full provenance. You need Python 3.8+ and nothing else to start. An LLM API key is optional; pattern-based extraction works out of the box.
Use this after installation. If you still need setup help, start with the [Installation guide](installation). You need Python 3.8+ and nothing else to start. An LLM API key is optional; pattern-based extraction works out of the box.
---