Skip to content

SynapseKit/synapsekit-docs

Repository files navigation

SynapseKit

Official documentation site for SynapseKit — async-first Python framework for building LLM applications with RAG pipelines, agents, and graph workflows.


What's documented

Section Coverage
Getting Started Installation, quickstart, all install extras
RAG Pipelines Loaders, chunking, embeddings, retrieval, vector stores, memory
Agents ReAct, function calling, built-in tools, custom tools, executor
Graph Workflows StateGraph, parallel execution, conditional routing, Mermaid export
LLM Providers All 9 providers with configuration examples
API Reference Full class and method reference

Run locally

git clone https://github.com/SynapseKit/synapsekit-docs
cd synapsekit-docs
npm install
npm start

Opens at http://localhost:3000 with hot reload.

Build

npm run build

Output goes to build/. Serve locally with npm run serve.

Deploy

Pushes to main auto-deploy to GitHub Pages via GitHub Actions. No manual steps needed.


Contributing

Found a typo, outdated example, or a missing section? PRs and issues are welcome here.

For bugs or features in the library itself, open an issue in the main repo.


License

MIT

About

Documentation site for SynapseKit — async-first Python framework for RAG, agents, and graph workflows

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors