Skip to content

Commit 1c3c876

Browse files
committed
Update documentation
1 parent bca9f1e commit 1c3c876

File tree

6 files changed

+99
-12
lines changed

6 files changed

+99
-12
lines changed

docs/.partials/index-header.html

+4-8
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,18 @@
55
-->
66

77
<div class="text-center">
8-
<img class="index-header off-glb" src="./img/pydantic-ai-dark.svg#only-dark" alt="PydanticAI">
8+
<img class="index-header off-glb" src="./img/banner-dark.png#only-dark" alt="PydanticAI">
99
</div>
1010
<div class="text-center">
11-
<img class="index-header off-glb" src="./img/pydantic-ai-light.svg#only-light" alt="PydanticAI">
11+
<img class="index-header off-glb" src="./img/banner-light.png#only-light" alt="PydanticAI">
1212
</div>
1313
<p class="text-center">
14-
<em>Agent Framework / shim to use Pydantic with LLMs</em>
14+
<em>Empowering Collaboration, Simplifying Complexity</em>
1515
</p>
1616
<p class="text-center">
1717
<a href="https://github.com/ceylonai/ceylon/actions/workflows/ci.yml?query=branch%3Amain">
1818
<img src="https://github.com/ceylonai/ceylon/actions/workflows/ci.yml/badge.svg?event=push" alt="CI">
1919
</a>
20-
<a href="https://coverage-badge.samuelcolvin.workers.dev/redirect/ceylonai/ceylon">
21-
<img src="https://coverage-badge.samuelcolvin.workers.dev/ceylonai/ceylon.svg" alt="Coverage">
22-
</a>
2320
<a href="https://pypi.python.org/pypi/ceylon">
2421
<img src="https://img.shields.io/pypi/v/ceylon.svg" alt="PyPI">
2522
</a>
@@ -32,6 +29,5 @@
3229
</p>
3330

3431
<p class="text-emphasis">
35-
PydanticAI is a Python agent framework designed to make it less painful to
36-
build production grade applications with Generative AI.
32+
Ceylon orchestrates AI agents to automate complex tasks through collaborative problem-solving.
3733
</p>

docs/extra/tweaks.css

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
/*
2+
* Copyright 2024-Present, Syigen Ltd. and Syigen Private Limited. All rights reserved.
3+
* Licensed under the Apache License, Version 2.0 (See LICENSE.md or http://www.apache.org/licenses/LICENSE-2.0).
4+
*
5+
*/
6+
7+
/* Revert hue value to that of pre mkdocs-material v9.4.0 */
8+
[data-md-color-scheme="slate"] {
9+
--md-hue: 230;
10+
--md-default-bg-color: hsla(230, 15%, 21%, 1);
11+
}
12+
13+
.hide {
14+
display: none;
15+
}
16+
17+
.text-center {
18+
text-align: center;
19+
}
20+
21+
img.index-header {
22+
width: 70%;
23+
max-width: 500px;
24+
}
25+
26+
.pydantic-pink {
27+
color: #FF007F;
28+
}
29+
30+
.team-blue {
31+
color: #0072CE;
32+
}
33+
34+
.secure-green {
35+
color: #00A86B;
36+
}
37+
38+
.shapes-orange {
39+
color: #FF7F32;
40+
}
41+
42+
.puzzle-purple {
43+
color: #652D90;
44+
}
45+
46+
.wheel-gray {
47+
color: #6E6E6E;
48+
}
49+
50+
.vertical-middle {
51+
vertical-align: middle;
52+
}
53+
54+
.text-emphasis {
55+
font-size: 1rem;
56+
font-weight: 300;
57+
font-style: italic;
58+
}
59+
60+
#version-warning {
61+
min-height: 120px;
62+
margin-bottom: 10px;
63+
}
64+
65+
.mermaid {
66+
text-align: center;
67+
}

docs/img/banner-dark.png

60 KB
Loading

docs/img/banner-light.png

59.4 KB
Loading

docs/index.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
# Introduction
1+
# Introduction {.hide}
22

3-
> Empowering Collaboration, Simplifying Complexity
3+
--8<-- "docs/.partials/index-header.html"
44

5-
![PyPI - Version](https://img.shields.io/pypi/v/ceylon.svg) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ceylon.svg) ![PyPI Downloads](https://img.shields.io/pypi/dm/ceylon)
5+
6+
[//]: # (![PyPI - Version]&#40;https://img.shields.io/pypi/v/ceylon.svg&#41; ![PyPI - Python Version]&#40;https://img.shields.io/pypi/pyversions/ceylon.svg&#41; ![PyPI Downloads]&#40;https://img.shields.io/pypi/dm/ceylon&#41;)
67

78
## Introduction
89

mkdocs.yml

+24-1
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,31 @@ theme:
5353
locale: en
5454
highlightjs: true
5555

56+
extra_css:
57+
- "extra/tweaks.css"
58+
59+
5660
use_directory_urls: false
5761

5862
plugins:
5963
- search
60-
- tags
64+
- tags
65+
66+
markdown_extensions:
67+
- tables
68+
- admonition
69+
- attr_list
70+
- md_in_html
71+
- pymdownx.details
72+
- pymdownx.caret
73+
- pymdownx.critic
74+
- pymdownx.mark
75+
- pymdownx.superfences
76+
- pymdownx.snippets
77+
- pymdownx.tilde
78+
- pymdownx.inlinehilite
79+
- pymdownx.tabbed:
80+
alternate_style: true
81+
- pymdownx.tasklist:
82+
custom_checkbox: true
83+
- sane_lists # this means you can start a list from any number

0 commit comments

Comments
 (0)