Skip to content

Commit

Permalink
update overview page
Browse files Browse the repository at this point in the history
  • Loading branch information
chdeskur committed Jan 29, 2025
1 parent dfa7c2d commit 2619b09
Show file tree
Hide file tree
Showing 5 changed files with 295 additions and 67 deletions.
11 changes: 11 additions & 0 deletions fern/assets/custom-styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,14 @@
.fern-background {
background-size: auto !important;
}

.fern-sidebar-heading-content {
text-transform: uppercase !important;
font-weight: 500 !important;
font-size: 14px !important;
}

.fern-sidebar-link-text {
font-weight: 400 !important;
font-size: 14px !important;
}
Binary file added fern/assets/img/landing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions fern/assets/logo-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 34 additions & 7 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ instances:
repo: assemblyai-api-spec
branch: fern/add-docs
title: AssemblyAI | API Reference
landing-page:
page: Home
path: pages/home.mdx
tabs:
docs:
display-name: Documentation
Expand All @@ -34,9 +31,14 @@ navigation:
layout:
- section: Getting started
contents:
- page: Overview
icon: regular house
path: pages/home.mdx
- page: Transcribe an audio file
icon: regular file-audio
path: pages/01-getting-started/transcribe-an-audio-file.mdx
- section: Transcribe streaming audio from a microphone
- section: Transcribe streaming audio
icon: regular microphone
# TODO: construct overview page
# path: pages/01-getting-started/transcribe-streaming-audio.mdx
contents:
Expand All @@ -51,33 +53,45 @@ navigation:
- page: Java
path: pages/01-getting-started/transcribe-streaming-audio-from-a-microphone/java.mdx
- page: Apply LLMs to audio files
icon: regular binary
path: pages/01-getting-started/apply-llms-to-audio-files.mdx
- page: Webhooks
icon: regular webhook
path: pages/01-getting-started/webhooks.mdx
- page: Supported Languages
icon: regular language
path: pages/01-getting-started/supported-languages.mdx
- page: Usage limits
icon: regular bolt-lightning
path: pages/01-getting-started/usage-limits.mdx
- section: Speech-to-text
contents:
- page: Speech Recognition
icon: regular comment
path: pages/02-speech-to-text/speech-recognition.mdx
- page: Speaker Diarization
icon: regular user-group
path: pages/02-speech-to-text/speaker-diarization.mdx
- page: Streaming
icon: regular signal-stream
path: pages/02-speech-to-text/streaming.mdx
- section: LeMUR - LLMs for speech
slug: lemur
contents:
- page: Summarize your audio data
icon: regular file-lines
path: pages/04-lemur/summarize-audio.mdx
- page: Ask questions about your audio data
icon: regular messages
path: pages/04-lemur/ask-questions.mdx
- page: Create custom LLM prompts
icon: regular question
path: pages/04-lemur/examples.mdx
- page: Change model and parameters
icon: regular terminal
path: pages/04-lemur/customize-parameters.mdx
- page: Prompt engineering
icon: regular code
path: pages/04-lemur/improving-your-prompt.mdx
# - section: Audio Intelligence
# contents:
Expand Down Expand Up @@ -212,16 +226,29 @@ navigation:
- tab: changelog

colors:
accent-primary: "#df9844"
background: "#09060F"
header-background: "#09060F"
accent-primary:
light: "#2545D3"
dark: "#df9844"
background:
light: "#FFFFFF"
dark: "#09060F"
header-background:
light: "#FFFFFF"
dark: "#09060F"
border:
light: "#E5E5E5"
dark: "#2A2522"
sidebar-background:
light: "#FFFFFF"
dark: "#09060F"
layout:
page-width: full
searchbar-placement: header
header-height: 80px
sidebar-width: 316px
tabs-placement: header
logo:
light: ./assets/logo-light.svg
dark: ./assets/AssemblyAI_White.svg
height: 32
href: /
Expand Down
Loading

0 comments on commit 2619b09

Please sign in to comment.