Skip to content

Commit 8f3420a

Browse files
authored
Doc styling and minor changes (#526)
2 parents 7eae455 + acf8726 commit 8f3420a

File tree

7 files changed

+53
-7
lines changed

7 files changed

+53
-7
lines changed

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# 🇪🇺 AI-on-Demand Metadata Catalogue
22

3-
The AI-on-Demand Metadata Catalogue provides a unified view of AI assets and resources stored across the AI landscape.
3+
The [AI-on-Demand](https://aiod.eu) Metadata Catalogue is part of the provides a unified view of AI assets and resources stored across the AI landscape.
44
It collects metadata from platforms such as [_Hugging Face_](https://huggingface.co), [_OpenML_](https://openml.org), and [_Zenodo_](https://zenodo.org),
55
and is connected to European projects like [Bonsapps](https://bonsapps.eu) and [AIDA](https://www.i-aida.org).
6-
Metadata of datasets, models, papers, news, and more from all of these sources is available through a REST API at [api.aiod.eu](https://api.aiod.eu/).
6+
Metadata of datasets, models, papers, news, and more from all of these sources is available through a REST API at [https://api.aiod.eu](https://api.aiod.eu/).
77

88
**🧑‍🔬 For most users:**
99
Many users will only use the REST API indirectly, for example;
10-
through the [Python SDK](https://aiondemand.github.io/aiondemand/) to access all (meta)data in Python scripts, the
11-
[AIoD website](aiod.eu), including services such as [My Resources](https://github.com/aiondemand/AIOD-marketplace-frontend/) to browse assets,
10+
through the [Python SDK](https://aiondemand.github.io/aiondemand/) to access all (meta)data in Python scripts, the
11+
[AIoD website](https://aiod.eu), including services such as [My Resources](https://github.com/aiondemand/AIOD-marketplace-frontend/) to browse assets,
1212
and [RAIL](https://github.com/aiondemand/aiod-rail) to conduct reproducible ML experiments.
1313
For documentation on how to use the REST API directly, visit the ["Using the API"](https://aiondemand.github.io/AIOD-rest-api/using/) guide.
1414

docs/hosting/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ Then run the startup commands again (either `up.sh` or `docker compose`).
114114
By default, the server will create a database on the provided MySQL server if it does not yet exist.
115115
You can change this behavior through the **build-db** command-line parameter,
116116
it takes the following options:
117+
117118
* never: *never* creates the database, not even if there does not exist one yet.
118119
Use this only if you expect the database to be created through other means, such
119120
as MySQL group replication.
12.2 KB
Loading

docs/media/upload_and_review.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/stylesheets/extra.css

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
:root > * {
2+
--md-primary-fg-color: #0047BB; /* banner */
3+
}
4+
5+
[data-md-color-scheme=slate] {
6+
--md-default-fg-color: #C5C6C8;
7+
--md-default-fg-color--light: #C5C6C8;
8+
}
9+
10+
[data-md-color-scheme=default] {
11+
--md-default-fg-color: #545557;
12+
}
13+
14+
15+
/* AIOD colors
16+
dark blue: #0047BB
17+
alternative dark blue: #003399:
18+
light blue: #41B6E6
19+
yellow: #FFED00
20+
dark gray: #646567
21+
light gray: #C5C6C8
22+
*/
23+
24+
/* At the default height and margin, the logo for AIoD is not recognizable. */
25+
.md-header__button.md-logo {
26+
margin: 0;
27+
padding: 0;
28+
}
29+
30+
.md-header__button.md-logo img, .md-header__button.md-logo svg {
31+
height: 2.4rem;
32+
width: 2.4rem;
33+
}

docs/using/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,17 @@ The REST API allows you to retrieve, update, or remove asset metadata in the met
44
The assets are indexed from many different platforms, such as educational resources from [AIDA](https://www.i-aida.org),
55
datasets from [HuggingFace](https://huggingface.co), models from [OpenML](https://openml.org), and many more.
66

7-
The REST API is available at [`https://api.aiod.eu`](https://api.aiod.eu) and documentation on endpoints
7+
The REST API is available at [https://api.aiod.eu](https://api.aiod.eu) and documentation on endpoints
88
is available on complementary [Swagger](https://api.aiod.eu/docs) and [ReDoc](https://api.aiod.eu/redoc) pages.
99

1010
To use the REST API, simply make HTTP requests to the different endpoints.
11-
Generally, these are `GET` requests when retrieving data, `PUT` requests when modifying data, `POST` requests when adding data, and `DEL` requests when deleting data.
11+
Generally, these are `GET` requests when retrieving data, `PUT` requests when modifying data, `POST` requests when adding data, and `DEL` requests when deleting data. The video and text below show examples on how to use the REST API.
12+
13+
## Introduction Video
14+
15+
<iframe width="560" height="315" src="https://www.youtube.com/embed/2nDj1_VjcWM?si=ncD7xaifSmbU5uzZ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
16+
17+
## A Quick Example
1218
Here are some examples on how to list datasets in different environments:
1319

1420
=== "Python (requests)"

mkdocs.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ repo_url: https://github.com/aiondemand/AIOD-rest-api
44
edit_uri: edit/develop/docs/
55
theme:
66
name: material
7+
logo: media/secondary-neg-white-25p.webp
78
features:
89
- content.code.copy
910
- navigation.footer
@@ -12,6 +13,8 @@ theme:
1213
icon:
1314
edit: material/pencil
1415
view: material/eye
16+
font:
17+
text: 'Montserrat'
1518
palette:
1619
# Palette toggle for light mode
1720
- media: "(prefers-color-scheme: light)"
@@ -27,6 +30,9 @@ theme:
2730
icon: material/brightness-4
2831
name: Switch to light mode
2932

33+
extra_css:
34+
- stylesheets/extra.css
35+
3036

3137
nav:
3238
- Home: README.md

0 commit comments

Comments
 (0)