Skip to content

Commit

Permalink
Merge pull request #19 from telekom/modifications-florian
Browse files Browse the repository at this point in the history
fix links, fix local development use
  • Loading branch information
FPullem authored Nov 29, 2024
2 parents 8393762 + b93e65c commit 61c3903
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/01_Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Our LLM model serving enables effortless querying of open-source LLM models like

## Our API Suite
:::tip
Begin with our APIs by exploring the [**Quickstart Guide**](./Quickstart.md) 🚀 for setup and integration instructions.
Begin with our APIs by exploring the [**Quickstart Guide**](./03_Quickstart.md) 🚀 for setup and integration instructions.
Our API suite provides everything you need to interact seamlessly with advanced language models, allowing for customization, secure data handling, and efficient deployment across various applications.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/02_Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Welcome to AI Foundation Services - your gateway to private, secure, and scalabl
### Get Started

1. **Request a Trial API key:** [Fill out our form](https://docs.google.com/forms/d/e/1FAIpQLSdBDhCijYUIUeyJVTLzCy0rm55XgD2nG5supwtGRHXVfaX-fw/viewform) to receive your API key.
2. **Run your first query:** Once you have your API key, [dive into querying LLMs](./Quickstart.md) to unlock their potential.
2. **Run your first query:** Once you have your API key, [dive into querying LLMs](./03_Quickstart.md) to unlock their potential.

## Our Product
### Magenta SmartChat {#magenta-smartchat}
Expand Down
6 changes: 3 additions & 3 deletions docs/03_Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ To securely connect to our API, you’ll need to generate an API key from the da

---
:::tip
You can see the list of our available models by using the command from [<span style={{ color: 'red', fontWeight: 'bold' }}>API Reference</span>](./Model%20Serving/API%20Reference.md#list-of-available-models) or view the [<span style={{ color: 'red', fontWeight: 'bold' }}>list of available models</span>](./Overview.md#available-llm-apis-on-ai-foundation-services).
You can see the list of our available models by using the command from [<span style={{ color: 'red', fontWeight: 'bold' }}>API Reference</span>](./04_Model%20Serving/API%20Reference.md#list-of-available-models) or view the [<span style={{ color: 'red', fontWeight: 'bold' }}>list of available models</span>](./01_Overview.md#available-llm-apis-on-ai-foundation-services).
:::

---
Expand Down Expand Up @@ -154,6 +154,6 @@ You can see the list of our available models by using the command from [<span st

### Next Steps

You’re all set up! Now, explore different models and tune parameters like `temperature` and `max_tokens` to refine responses. For specialized use cases like RAG, see our **[LangChain](./Model%20Serving/Langchain%20Migration.md)** and **[Llama-Index Integration](./Model%20Serving/Llama-Index%20Intergration.md)** sections in the documentation.
You’re all set up! Now, explore different models and tune parameters like `temperature` and `max_tokens` to refine responses. For specialized use cases like RAG, see our **[LangChain](./04_Model%20Serving/Langchain%20Migration.md)** and **[Llama-Index Integration](./04_Model%20Serving/Llama-Index%20Intergration.md)** sections in the documentation.

**Note**: For any model-specific requirements or best practices, consult the [API Reference](./Model%20Serving/API%20Reference.md) section of this documentation.
**Note**: For any model-specific requirements or best practices, consult the [API Reference](./04_Model%20Serving/API%20Reference.md) section of this documentation.
7 changes: 4 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 8 additions & 5 deletions src/theme/Navbar/switchMode.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';

if (ExecutionEnvironment.canUseDOM) {
const element = document.getElementById('mode-switch');

element.addEventListener('click', function switchMode() {
const isDark = document.body.dataset.mode === 'dark';
document.body.dataset.mode = isDark ? 'light' : 'dark';
document.addEventListener('DOMContentLoaded', () => {
const element = document.getElementById('mode-switch');
if (element) {
element.addEventListener('click', function switchMode() {
const isDark = document.body.dataset.mode === 'dark';
document.body.dataset.mode = isDark ? 'light' : 'dark';
});
}
});
}

0 comments on commit 61c3903

Please sign in to comment.