Skip to content

Commit bc01221

Browse files
authored
Document Updates (#221)
1 parent e1bc1ac commit bc01221

File tree

5 files changed

+40
-44
lines changed

5 files changed

+40
-44
lines changed

docs/content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The {{< full_app_ref >}} provides a streamlined environment where developers and
1919
- **RAG**: Enhances **LLM**s by retrieving relevant, real-time information allowing models to provide up-to-date and accurate responses.
2020
- **Vector Database**: A database, including Oracle Database 23ai, that can natively store and manage vector embeddings and handle the unstructured data they describe, such as documents, images, video, or audio.
2121

22-
## {{< short_app_ref >}} Features
22+
## Features
2323

2424
- [Configuring Embedding and Chat Models](client/configuration/model_config)
2525
- [Splitting and Embedding Documentation](client/tools/split_embed)

docs/content/client/configuration/db_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The database can either be configured through the [{{< short_app_ref >}} interfa
1818

1919
---
2020

21-
### {{< short_app_ref >}} Interface
21+
### Interface
2222

2323
To configure the Database from the {{< short_app_ref >}}, navigate to `Configuration -> Database`:
2424

docs/content/client/configuration/oci_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You will need to [generate an API Key](https://docs.oracle.com/en-us/iaas/Conten
2222

2323
---
2424

25-
### {{< short_app_ref >}} Interface
25+
### Interface
2626

2727
To configure the Database from the {{< short_app_ref >}}, navigate to `Configuration -> OCI`:
2828

docs/content/walkthrough/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ To enable the **RAG** functionality, access to an embedding model is required. T
125125
podman exec -it ollama ollama pull mxbai-embed-large
126126
```
127127

128-
### The {{< short_app_ref >}}
128+
### The AI Optimizer
129129

130130
The {{< short_app_ref >}} provides an easy to use front-end for experimenting with **LLM** parameters and **RAG**.
131131

docs/layouts/partials/menu-footer.html

Lines changed: 36 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,39 @@
44
55
spell-checker: ignore Luma, assetbusting, SMPTE, octicon
66
-->
7-
{{- $assetBusting := partialCached "assetbusting.gotmpl" . }}
8-
<span class="github-buttons"></span>
9-
<p>Built with <a href="https://github.com/oracle-samples/ai-optimizer" title="love"><i class="fas fa-heart"></i></a> by <a href="https://www.oracle.com/"><span style="color:#C74634;">ORACLE</span></a></p>
10-
<script>
11-
function githubButtonsScheme(){
12-
var scheme = 'light';
13-
var colorPropertyValue = window.getComputedStyle( document.querySelector( '#R-sidebar' ) ).getPropertyValue( 'background-color' );
14-
var colorValues = colorPropertyValue.match( /\d+/g ).map( function( e ){ return parseInt(e,10); });
15-
if( colorValues.length === 3 && ((0.2126 * colorValues[0]) + (0.7152 * colorValues[1]) + (0.0722 * colorValues[2]) < 165) ){
16-
scheme = 'dark';
17-
}
18-
return scheme;
19-
}
20-
function githubButtonsInit(){
21-
if( !window.githubButtons ){
22-
setTimeout( githubButtonsInit, 50 );
23-
return;
24-
}
25-
var scheme = githubButtonsScheme();
26-
var githubButtonsHTML = `
27-
<a class="github-button" href="https://github.com/oracle-samples/ai-optimizer/archive/main.zip" data-color-scheme="${scheme}" data-icon="octicon-cloud-download" aria-label="Download the AI Optimizer on GitHub">Download</a>
28-
<a class="github-button" href="https://github.com/oracle-samples/ai-optimizer" data-color-scheme="${scheme}" data-icon="octicon-star" data-show-count="true" aria-label="Star the AI Optimizer on GitHub">Star</a>
29-
<a class="github-button" href="https://github.com/oracle-samples/ai-optimizer/fork" data-color-scheme="${scheme}" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork the AI Optimizer on GitHub">Fork</a>
30-
`;
31-
document.querySelector( '.github-buttons' ).innerHTML = githubButtonsHTML;
32-
document.querySelectorAll( '.github-button' ).forEach( function( anchor ){
33-
anchor.dataset.colorScheme = scheme;
34-
window.githubButtons.render( anchor, function( el ){
35-
anchor.parentNode.replaceChild( el, anchor );
36-
});
37-
});
38-
}
39-
document.addEventListener( 'themeVariantLoaded', function( e ){
40-
setTimeout( githubButtonsInit, 400 );
41-
});
42-
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
43-
setTimeout( githubButtonsInit, 400 );
44-
});
45-
</script>
46-
<script async src="{{"js/github-buttons.js" | relURL}}{{ $assetBusting }}"></script>
7+
<p>Built with <a href="https://github.com/oracle-samples/ai-optimizer" title="love"><i class="fas fa-heart"></i></a> by <a href="https://www.oracle.com/"><span style="color:#C74634;">ORACLE</span></a></p>
8+
<span class="github-buttons">
9+
<!-- Buttons will be injected here -->
10+
</span>
11+
12+
<script>
13+
function getColorScheme() {
14+
const bg = getComputedStyle(document.querySelector('#R-sidebar')).getPropertyValue('background-color');
15+
const [r, g, b] = bg.match(/\d+/g).map(Number);
16+
const luminance = 0.2126 * r + 0.7152 * g + 0.0722 * b;
17+
return luminance < 165 ? 'dark' : 'light';
18+
}
19+
20+
function injectGithubButtons() {
21+
const scheme = getColorScheme();
22+
const container = document.querySelector('.github-buttons');
23+
if (!container) return;
24+
25+
container.innerHTML = `
26+
<a class="github-button" href="https://github.com/oracle-samples/ai-optimizer/archive/main.zip" data-icon="octicon-cloud-download" data-color-scheme="${scheme}" aria-label="Download the AI Optimizer on GitHub">Download</a>
27+
<a class="github-button" href="https://github.com/oracle-samples/ai-optimizer" data-icon="octicon-star" data-show-count="true" data-color-scheme="${scheme}" aria-label="Star the AI Optimizer on GitHub">Star</a>
28+
<a class="github-button" href="https://github.com/oracle-samples/ai-optimizer/fork" data-icon="octicon-repo-forked" data-show-count="true" data-color-scheme="${scheme}" aria-label="Fork the AI Optimizer on GitHub">Fork</a>
29+
`;
30+
31+
// Load GitHub Buttons script
32+
const script = document.createElement('script');
33+
script.src = "https://buttons.github.io/buttons.js";
34+
script.async = true;
35+
document.body.appendChild(script);
36+
}
37+
38+
document.addEventListener('DOMContentLoaded', injectGithubButtons);
39+
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
40+
setTimeout(injectGithubButtons, 300);
41+
});
42+
</script>

0 commit comments

Comments
 (0)