Skip to content

Commit

Permalink
fix: change all links into realative links
Browse files Browse the repository at this point in the history
  • Loading branch information
AmirLavasani committed Jul 10, 2024
1 parent fc0e745 commit 213b543
Show file tree
Hide file tree
Showing 19 changed files with 85 additions and 78 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,10 @@ To build the static website:
mkdocs build
```

This will create a `site` directory with your static documentation website ready to be hosted.
This will create a `site` directory with your static documentation website ready to be hosted.

### Notes
1. Use relative links for internal navigation.

> Example:
You can find out more examples at `[inteliver Examples](../examples/index.md)`
2 changes: 1 addition & 1 deletion docs/examples/crop.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ i_c_object_person,i_h_200,i_w_200,i_o_crop
/000931783192390000000000000000000704.jpeg)</center>

!!! info
You can lookup the object detection [API reference](/api-reference/object-detection/) to see all the objects we detect in images.
You can lookup the object detection [API reference](../api-reference/object-detection.md) to see all the objects we detect in images.


#### Round Crop
Expand Down
24 changes: 12 additions & 12 deletions docs/examples/operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ weight: 2
Modify your image data using a variety of image processing functions. These functionality includes
the following.

* [Resize](/examples/resize)
* [Crop](/examples/crop)
* [Rotate](/examples/rotate)
* [Flip](/examples/flip)
* [Blur](/examples/blur)
* [Pixelate](/examples/pixelate)
* [Sharpen](/examples/sharpen)
* [Gray Scale](/examples/gray-scale)
* [Text Overlay](/examples/text-overlay)
* [Resize](resize.md)
* [Crop](crop.md)
* [Rotate](rotate.md)
* [Flip](flip.md)
* [Blur](blur.md)
* [Pixelate](pixelate.md)
* [Sharpen](sharpen.md)
* [Gray Scale](gray-scale.md)
* [Text Overlay](text-overlay.md)

Each operation has examples and you can also refer to [API reference](/api-reference) section for complete list of args.
Each operation has examples and you can also refer to [API reference](../api-reference/index.md) section for complete list of args.

The examples uses inteliver intuitive URL query commands. Please refer to [intuitive query commands](/image-management/query-commands) for more information on our URL query commands.
The examples uses inteliver intuitive URL query commands. Please refer to [intuitive query commands](../getting-started/integration.md) for more information on our URL query commands.

!!! success
For more information on how to apply these functionalities using our SDKs please refer to [libraries](/libraries).
For more information on how to apply these functionalities using our SDKs please refer to [libraries](../libraries/index.md).
2 changes: 1 addition & 1 deletion docs/examples/pixelate.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@ i_c_object_dog,i_o_pixelate_10
<center>[![Pixelate]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_object_dog,i_o_pixelate_10/000932453002500000000000000000000097.jpeg)]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_object_dog,i_o_pixelate_10/000932453002500000000000000000000097.jpeg)</center>

!!! note
You can lookup the object detection [API reference](/api-reference/object-detection/) to see all the objects we detect in images.
You can lookup the object detection [API reference](../api-reference/object-detection.md) to see all the objects we detect in images.
2 changes: 1 addition & 1 deletion docs/examples/selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ Using A.I. features possibilities are simply endless.
Using Inteliver A.I. text detection you can apply image processing functions only on texts. For example pixelating a car plate or applying faster OCR on texts in an image.

!!! info
In the [examples](/examples) for each operation we show you how to exploit the full potential of these selection methods.
In the following examples for each operation we show you how to exploit the full potential of these selection methods.
2 changes: 1 addition & 1 deletion docs/examples/sharpen.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ i_c_object_car,i_o_sharpen
<center>[![Original Image]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_object_car,i_o_sharpen/000932511633980000000000000000000518.jpeg)]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_object_car,i_o_sharpen/000932511633980000000000000000000518.jpeg)</center>

!!! note
You can lookup the object detection [API reference](/api-reference/object-detection/) to see all the objects we detect in images.
You can lookup the object detection [API reference](../api-reference/object-detection.md) to see all the objects we detect in images.


### Face Sharpen
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/text-overlay.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ i_c_y_100,i_c_x_-140,i_o_text_inteliver_2.5_1_14_70_160
<center>[![Textoverlay]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_y_100,i_c_x_-140,i_o_text_inteliver_2.5_7_14_70_160/000932246193860000000000000000000437.jpeg)]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_y_100,i_c_x_-140,i_o_text_inteliver_2.5_7_14_70_160/000932246193860000000000000000000437.jpeg)</center>

!!! note
You can refer to the text overlay [API reference](/api-reference/text-overlay/) to see all the possible values for arguments.
You can refer to the text overlay [API reference](../api-reference/text-overlay.md) to see all the possible values for arguments.
5 changes: 3 additions & 2 deletions docs/getting-started/image-ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,10 @@ Lets say we want to crop the cars in a set of images:
!!! note
Here we first select car's object by `i_c_object_truck` and then crop it using `i_o_crop` operation.

There are also more examples in [object detection examples](/examples/object-detection).
There are also more examples in [object detection examples](../examples/object-detection.md).

you can also refer to [API reference](/api-reference/object-detection/) section for complete list of args.
!!! info
you can also refer to [API reference](../api-reference/object-detection.md) section for complete list of args.


## Face Detection
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/image-compression.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ Here is an image with Real-Time WEBP compression levels of 80, 50 and 20.
<center>Compressed Image Size: <strong>7.1 KB</strong></center>
<center>Compression Ratio: <strong>~37</strong></center>

you can also refer to [API reference](/api-reference/compression/) section for complete list of args.
you can also refer to [API reference](../api-reference/compression.md) section for complete list of args.
26 changes: 13 additions & 13 deletions docs/getting-started/image-modification.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ title: "Image Modification"
Modify your image data using a variety of image processing functions. These functionality includes
the following.

- [x] [Resize](/examples/resize)
- [x] [Crop](/examples/crop)
- [x] [Rotate](/examples/rotate)
- [x] [Flip](/examples/flip)
- [x] [Blur](/examples/blur)
- [x] [Pixelate](/examples/pixelate)
- [x] [Sharpen](/examples/sharpen)
- [x] [Gray Scale](/examples/gray-scale)
- [x] [Text Overlay](/examples/text-overlay)
- [x] [Resize](../examples/resize.md)
- [x] [Crop](../examples/crop.md)
- [x] [Rotate](../examples/rotate.md)
- [x] [Flip](../examples/flip.md)
- [x] [Blur](../examples/blur.md)
- [x] [Pixelate](../examples/pixelate.md)
- [x] [Sharpen](../examples/sharpen.md)
- [x] [Gray Scale](../examples/gray-scale.md)
- [x] [Text Overlay](../examples/text-overlay.md)


### Here are simple examples:
Expand Down Expand Up @@ -86,20 +86,20 @@ the following.

<center>Real-Time Gray Scale</center>

Each operation has [examples](/examples) and you can also refer to [API reference](/api-reference) section for complete list of args.
Each operation has [examples](../examples/index.md) and you can also refer to [API reference](../api-reference/index.md) section for complete list of args.

The examples uses inteliver intuitive URL query commands. Please refer to [intuitive query commands](/getting-started/how-inteliver-works) for more information on our URL query commands.
The examples uses inteliver intuitive URL query commands. Please refer to [intuitive query commands](how-inteliver-works.md) for more information on our URL query commands.

!!! note
For more information on how to apply these functionalities using our SDKs please refer to [libraries](/libraries).
For more information on how to apply these functionalities using our SDKs please refer to [libraries](../libraries/index.md).

## Image Selection

You can apply the operation on different part of image. For selecting the part of image you want to apply
an operation you can use the following different selections.


There are examples of each one in [selection section](/examples/selection/) in examples.
There are examples of each one in [selection section](../examples/index.md) in examples.

* Window Selection
* Face Selection
Expand Down
32 changes: 16 additions & 16 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ Welcome to Inteliver, an open-source image management framework designed to stor
This guide will help you get up and running with Inteliver, covering the essential concepts and features.

## What We'll Cover
- [x] [Installation and Quick Start](/getting-started/installation): How to install Inteliver and get started.
- [x] [How Inteliver Works](/getting-started/how-inteliver-works): Understanding query commands and the core functionality.
- [x] [Easy Integration](/getting-started/integration): Leveraging intuitive URLs, SDK integration, and DNS integration.
- [x] [Image Modifications Features](/getting-started/image-modification): Exploring the various image modification options.
- [x] [Real-Time Image Compression](/getting-started/image-compression): Understanding the image compression capabilities.
- [x] [A.I. and Image Information](/getting-started/image-ai): Identify objects, Remove background, Detect faces and more.
- [x] [Inteliver Dashboard](/getting-started/inteliver-dashboard): Navigating and utilizing the Inteliver dashboard.
- [x] [Use Cases](/getting-started/usecases): Real-world applications and scenarios for Inteliver.
- [x] [Installation and Quick Start](installation.md): How to install Inteliver and get started.
- [x] [How Inteliver Works](how-inteliver-works.md): Understanding query commands and the core functionality.
- [x] [Easy Integration](integration.md): Leveraging intuitive URLs, SDK integration, and DNS integration.
- [x] [Image Modifications Features](image-modification.md): Exploring the various image modification options.
- [x] [Real-Time Image Compression](image-compression.md): Understanding the image compression capabilities.
- [x] [A.I. and Image Information](image-ai.md): Identify objects, Remove background, Detect faces and more.
- [x] [Inteliver Dashboard](inteliver-dashboard.md): Navigating and utilizing the Inteliver dashboard.
- [x] [Use Cases](usecases.md): Real-world applications and scenarios for Inteliver.

<div class="grid cards" markdown>

Expand All @@ -27,39 +27,39 @@ This guide will help you get up and running with Inteliver, covering the essenti

Install and [self-host inteliver](#) or use our [Cloud](#) version

[:octicons-arrow-right-24: Installation](/getting-started/installation)
[:octicons-arrow-right-24: Installation](installation.md)

- :fontawesome-solid-wand-magic-sparkles:{ .lg .middle } __How inteliver Works__

---

Explore inteliver's magic. Understand query commands and sky's the limit

[:octicons-arrow-right-24: Query Commands](/getting-started/how-inteliver-works)
[:octicons-arrow-right-24: Query Commands](how-inteliver-works.md)

- :simple-dask:{ .lg .middle } __Easy Integration__

---

Integrate using simple intuitive URLs, SDK integration, or DNS integration

[:octicons-arrow-right-24: Integration](/getting-started/integration)
[:octicons-arrow-right-24: Integration](integration.md)

- :material-image-check:{ .lg .middle } __Image Modifications__

---

Exploring the various image modification options.

[:octicons-arrow-right-24: Image Modifications](/getting-started/image-modification)
[:octicons-arrow-right-24: Image Modifications](image-modification.md)

- :material-quality-high:{ .lg .middle } __Real-Time Image Compression__

---

Deliver the best quality and size automatically

[:octicons-arrow-right-24: Image Compression](/getting-started/image-compression)
[:octicons-arrow-right-24: Image Compression](image-compression.md)


- :material-robot-happy:{ .lg .middle } __A.I. and Image Information__
Expand All @@ -68,23 +68,23 @@ This guide will help you get up and running with Inteliver, covering the essenti

Identify and tag objects, Remove background, Detect faces and more

[:octicons-arrow-right-24: A.I. Algorithms](/getting-started/image-ai)
[:octicons-arrow-right-24: A.I. Algorithms](image-ai.md)

- :material-quality-high:{ .lg .middle } __Inteliver Dashboard__

---

Using inteliver dashboard you can monitor and analyze all of the platform activity

[:octicons-arrow-right-24: Dashboard](/getting-started/inteliver-dashboard)
[:octicons-arrow-right-24: Dashboard](inteliver-dashboard.md)

- :material-quality-high:{ .lg .middle } __Use Cases__

---

Inteliver is versatile and can be applied in various scenarios

[:octicons-arrow-right-24: Use Cases](/getting-started/usecases)
[:octicons-arrow-right-24: Use Cases](usecases.md)

</div>

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: "Integration"

### Intuitive URLs

Without any change in your codes, you can modify your image resources using our intuitive url modifiers. Learn more about [intuitive urls](/image-management/query-commands/).
Without any change in your codes, you can modify your image resources using our intuitive url modifiers.

Inteliver delivers the data after processing the query commands and applying the algorithms.

Expand Down Expand Up @@ -35,9 +35,9 @@ i_w_300,i_o_resize_keep
### SDK Integration

Inteliver tries to minimize the integration process by providing SDKs in different programming languages.
Please visit our [libraries](/libraries/) section for integrating using an SDK.
Please visit our [libraries](../libraries/index.md) section for integrating using an SDK.

Inteliver currently provides [Javascript](/libraries/javascript/), [Python](/libraries/python/) and [React](/libraries/react/) SDKs.
Inteliver currently provides [Python](../libraries/python.md), [Javascript](../libraries/javascript.md), and [React](../libraries/react.md) SDKs.

!!! note
We are updating SDKs to be compatibale with our latest changes. Meanwhile we are more focused on Intuitive URL integration mode.
Expand Down
10 changes: 5 additions & 5 deletions docs/getting-started/inteliver-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Using our management dashboard you can keep track of your requests and sotrage.

You can see the library of your images along with analytics and user management.

<center>![Inteliver Panel Dashboard](/assets/npanel-dashboard.png#roundcorner "Inteliver Panel Dashboard")</center>
<center>![Inteliver Panel Dashboard](../assets/npanel-dashboard.png#roundcorner "Inteliver Panel Dashboard")</center>

## Analytics

Expand All @@ -23,18 +23,18 @@ Using our analytics section you can keep track of the following monthly and dail
- [x] Geolocation Information
- [x] Media Fromat Information

![Inteliver Panel Analytics](/assets/npanel-analytics-1.png#roundcorner "Inteliver Panel Analytics")
![Inteliver Panel Analytics](../assets/npanel-analytics-1.png#roundcorner "Inteliver Panel Analytics")

![Inteliver Panel Analytics](/assets/npanel-analytics-2.png#roundcorner "Inteliver Panel Analytics")
![Inteliver Panel Analytics](../assets/npanel-analytics-2.png#roundcorner "Inteliver Panel Analytics")

## Storage

Using storage section in panel you can upload your image resources and modify images using inteliver intuitive urls modifiers.

![Inteliver Panel Storage](/assets/npanel-storage.png#roundcorner "Inteliver Panel Storage")
![Inteliver Panel Storage](../assets/npanel-storage.png#roundcorner "Inteliver Panel Storage")

## Library

Using library section you can view the latest resources added to storage.

![Inteliver Panel Library](/assets/npanel-library.png#roundcorner "Inteliver Panel Library")
![Inteliver Panel Library](../assets/npanel-library.png#roundcorner "Inteliver Panel Library")
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Inteliver allows for real-time image modifications and customizations, ensuring

## :material-youtube: Watch Introduction Video in Youtube
<figure markdown="span">
[![inteliver Introduction Video](../assets/inteliver-introduction-video-snapshot.svg)](https://www.youtube.com/watch?v=8hEdIEvt7_E)
[![inteliver Introduction Video](assets/inteliver-introduction-video-snapshot.svg)](https://www.youtube.com/watch?v=8hEdIEvt7_E)
<figcaption>inteliver Introduction Video</figcaption>
</figure>

Expand All @@ -31,23 +31,23 @@ Inteliver allows for real-time image modifications and customizations, ensuring
Install [`inteliver`](#) with [`pip`](#) and get up
and running in minutes

[:octicons-arrow-right-24: Getting started](#)
[:octicons-arrow-right-24: Getting started](getting-started/index.md)

- :material-lightbulb-on-10:{ .lg .middle } __It just Works__

---

Focus on your core idea and inteliver does all the asset management for you

[:octicons-arrow-right-24: Reference](#)
[:octicons-arrow-right-24: How inteliver works?](getting-started/how-inteliver-works.md)

- :material-timer:{ .lg .middle } __Real-Time Image Modification__

---

Apply all sorts of image modification on the fly tailored to your client

[:octicons-arrow-right-24: Examples](/examples)
[:octicons-arrow-right-24: Examples](examples/index.md)

- :material-scale-balance:{ .lg .middle } __Open Source, MIT__

Expand Down
18 changes: 9 additions & 9 deletions docs/introduction/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ Modify your image data using a variety of image processing functions.

inteliver currently has the following image modifications.

- [x] [Resize](/examples/resize)
- [x] [Crop](/examples/crop)
- [x] [Rotate](/examples/rotate)
- [x] [Flip](/examples/flip)
- [x] [Blur](/examples/blur)
- [x] [Pixelate](/examples/pixelate)
- [x] [Sharpen](/examples/Sharpen)
- [x] [Gray Scale](/examples/gray-scale)
- [x] [Watermark](/examples/text-overlay)
- [x] [Resize](../examples/resize.md)
- [x] [Crop](../examples/crop.md)
- [x] [Rotate](../examples/rotate.md)
- [x] [Flip](../examples/flip.md)
- [x] [Blur](../examples/blur.md)
- [x] [Pixelate](../examples/pixelate.md)
- [x] [Sharpen](../examples/sharpen.md)
- [x] [Gray Scale](../examples/gray-scale.md)
- [x] [Watermark](../examples/text-overlay.md)


## 🔍 Image Information
Expand Down
8 changes: 4 additions & 4 deletions docs/libraries/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Inteliver minimizes the integration process through **Intuitive URL Modifier** c

Here are the list of our SDKs:

- [x] [Python](/libraries/python)
- [x] [NodeJS](/libraries/javascript)
- [x] [React](/libraries/react)
- [ ] [Golang](/libraries/golang)
- [x] [Python](../libraries/python.md)
- [x] [NodeJS](../libraries/javascript.md)
- [x] [React](../libraries/react.md)
- [ ] [Golang](../libraries/golang.md)


We are continuously working to expand our SDK offerings, ensuring that more languages and frameworks are supported. We encourage you to contribute if you don't see your preferred language or framework listed.
2 changes: 1 addition & 1 deletion docs/libraries/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,4 @@ The image you receive after modification is :


!!! info
You can find out about the image modification examples at [inteliver Examples](/examples/).
You can find out about the image modification examples at [inteliver Examples](../examples/index.md).
2 changes: 1 addition & 1 deletion docs/libraries/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,4 @@ The image you receive after modification is :


!!! info
You can find out about the image modification examples at [inteliver Examples](/examples/).
You can find out about the image modification examples at [inteliver Examples](../examples/index.md).
Loading

0 comments on commit 213b543

Please sign in to comment.