diff --git a/README.Rmd b/README.Rmd index 31989d6..70bc15b 100644 --- a/README.Rmd +++ b/README.Rmd @@ -11,6 +11,8 @@ knitr::opts_chunk$set( ) ``` +SAMY Data Science + # EndpointR diff --git a/README.md b/README.md index 10c035d..e21f3fa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ +SAMY Data Science + # EndpointR diff --git a/_pkgdown.yml b/_pkgdown.yml index 99b766b..89baf89 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,29 +1,47 @@ url: https://jpcompartir.github.io/EndpointR/ + template: bootstrap: 5 - params: - toc: true - toc_depth: 3 - toc_float: - collapsed: false - smooth_scroll: true - side: left - bootswatch: "flatly" - highlight: "tango" - code_folding: "show" - anchor_sections: true - search: true - + bslib: + # SAMY Brand Colours + bg: "#F5F5F4" + fg: "#2C2E35" + primary: "#B5651D" + secondary: "#D4A574" + success: "#7C9885" + info: "#5B7C99" + warning: "#D4A574" + danger: "#8B5A6F" + + # Typography + base_font: + google: "Lato" + heading_font: + google: "Merriweather" + code_font: + google: "Fira Code" + + # Component Styling + navbar-bg: "#2C2E35" + code-bg: "#FDFDFD" + code-color: "#5B7C99" home: title: "EndpointR" description: "A batteries-included R package for connecting to Machine Learning inference APIs" navbar: + bg: dark structure: - left: [intro, reference, articles, tutorials, news] + left: [intro, reference, articles, news] right: [search, github] components: + intro: + text: Get Started + href: articles/api_keys.html + reference: + text: Reference + href: reference/index.html articles: text: Articles menu: @@ -48,6 +66,14 @@ navbar: - text: Advanced Topics - text: Improving Performance href: articles/improving_performance.html + news: + text: Changelog + href: news/index.html + +footer: + structure: + left: developed_by + right: built_with reference: - title: "Getting Started" @@ -83,20 +109,19 @@ reference: - hf_perform_request - title: "Hugging Face Endpoint Utilities" - desc: "Small functions for checking things with Hugging FACE APIs" + desc: "Functions for checking Hugging Face API endpoints" contents: - hf_get_endpoint_info - hf_get_model_max_length - title: "Anthropic Messages" - desc: "functions for working with Anthropic's Messages API" + desc: "Functions for working with Anthropic's Messages API" contents: - ant_build_messages_request - ant_complete_text - ant_complete_chunks - ant_complete_df - - title: "OpenAI Completions" desc: "Functions for working with OpenAI's APIs including structured outputs" contents: @@ -115,6 +140,7 @@ reference: - oai_embed_chunks - oai_embed_df - tidy_oai_embedding + - title: "JSON Schema for Structured Outputs" desc: "Type-safe schema creation and validation for structured LLM outputs" contents: @@ -170,15 +196,10 @@ development: news: releases: - text: "Version 0.2" - href: nrews/index.html#endpointr-012 + href: news/index.html#endpointr-012 - text: "Version 0.1.2" href: news/index.html#endpointr-012 - text: "Version 0.1.1" href: news/index.html#endpointr-011 - text: "Version 0.1.0" href: news/index.html#endpointr-010 - -footer: - structure: - left: developed_by - right: built_with diff --git a/man/figures/samy_banner.png b/man/figures/samy_banner.png new file mode 100644 index 0000000..9418f7c Binary files /dev/null and b/man/figures/samy_banner.png differ diff --git a/man/figures/samy_logo_small.png b/man/figures/samy_logo_small.png new file mode 100644 index 0000000..4f8a3ba Binary files /dev/null and b/man/figures/samy_logo_small.png differ