Skip to content

Commit 31462f6

Browse files
committed
docs: link official Agora resources
1 parent a64d3b2 commit 31462f6

12 files changed

Lines changed: 156 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ Reference implementation for building Agora realtime voice agents as Vercel apps
44

55
Homepage: https://agora-realtime-agent.vercel.app/?utm_source=github&utm_medium=readme&utm_campaign=agora_voice_agents
66

7+
Official Agora resources:
8+
9+
- Agora: https://www.agora.io/en/
10+
- Agora Docs (English): https://docs.agora.io/en/
11+
- Agora realtime voice docs: https://docs.agora.io/en/realtime-media/voice
12+
- Agora AI and Conversational AI docs: https://docs.agora.io/en/ai
13+
714
Research baseline: 2026-07-02.
815

916
## Current direction

apps/website/app/docs/agora-realtime-react-package/page.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,10 @@ This boundary lets the same npm package power the hosted demo, the Vercel templa
9999

100100
## References
101101

102+
- Agora: https://www.agora.io/en/
103+
- Agora Docs (English): https://docs.agora.io/en/
104+
- Agora realtime voice docs: https://docs.agora.io/en/realtime-media/voice
105+
- Agora AI and Conversational AI docs: https://docs.agora.io/en/ai
102106
- Vercel AI SDK docs: https://ai-sdk.dev/docs
103107
- Vercel environment variables: https://vercel.com/docs/environment-variables
104108
- Agora realtime hook: `packages/agora-realtime-react/src/use-agora-realtime.ts`

apps/website/app/docs/deploy-agent-pipeline/page.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ npm run dev
3434

3535
## 1. Create the Agora project
3636

37-
In the Agora Console:
37+
In the [Agora Console](https://console.agora.io/):
3838

3939
1. Create or select an Agora project.
4040
2. Copy the App ID.
@@ -133,6 +133,11 @@ That split keeps sensitive Agora credentials out of the browser while still givi
133133

134134
## References
135135

136+
- Agora: https://www.agora.io/en/
137+
- Agora Docs (English): https://docs.agora.io/en/
138+
- Agora realtime voice docs: https://docs.agora.io/en/realtime-media/voice
139+
- Agora AI and Conversational AI docs: https://docs.agora.io/en/ai
140+
- Agora Console: https://console.agora.io/
136141
- Agora Agents SDK: `node_modules/agora-agents/README.md`
137142
- Template setup route: `templates/agora-agent-pipeline/app/api/agora/realtime/setup/route.ts`
138143
- Vercel monorepo deployment: https://vercel.com/docs/monorepos

apps/website/app/docs/install-voice-ring-with-shadcn/page.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,8 @@ and:
9898

9999
## References
100100

101+
- Agora: https://www.agora.io/en/
102+
- Agora Docs (English): https://docs.agora.io/en/
103+
- Agora realtime voice docs: https://docs.agora.io/en/realtime-media/voice
101104
- shadcn registry guide: https://ui.shadcn.com/docs/registry/getting-started
102105
- shadcn registry item schema: https://ui.shadcn.com/docs/registry/registry-item-json

apps/website/app/globals.css

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,67 @@ h1 {
466466
color: #a7f6ff;
467467
}
468468

469+
.official-resources {
470+
border-top: 1px solid rgba(244, 239, 228, 0.12);
471+
display: grid;
472+
gap: clamp(1rem, 4vw, 3rem);
473+
grid-template-columns: minmax(0, 0.86fr) minmax(0, 1.14fr);
474+
margin: 0 auto;
475+
max-width: 1180px;
476+
padding: 4rem clamp(1rem, 4vw, 2rem) 5rem;
477+
position: relative;
478+
z-index: 1;
479+
}
480+
481+
.resource-heading {
482+
display: grid;
483+
gap: 0.9rem;
484+
}
485+
486+
.resource-heading h2 {
487+
font-size: clamp(1.9rem, 4vw, 3.4rem);
488+
line-height: 1;
489+
}
490+
491+
.resource-heading p:not(.eyebrow) {
492+
color: rgba(244, 239, 228, 0.72);
493+
font-size: 1rem;
494+
line-height: 1.68;
495+
}
496+
497+
.resource-grid {
498+
display: grid;
499+
gap: 0.75rem;
500+
grid-template-columns: repeat(2, minmax(0, 1fr));
501+
}
502+
503+
.resource-card {
504+
border: 1px solid var(--site-border);
505+
border-radius: 8px;
506+
display: grid;
507+
gap: 0.7rem;
508+
min-height: 9.5rem;
509+
padding: 1rem;
510+
}
511+
512+
.resource-card:hover {
513+
background: rgba(244, 239, 228, 0.06);
514+
border-color: rgba(76, 238, 255, 0.34);
515+
}
516+
517+
.resource-card span {
518+
color: var(--site-cyan);
519+
font-size: 0.84rem;
520+
font-weight: 850;
521+
text-transform: uppercase;
522+
}
523+
524+
.resource-card p {
525+
color: rgba(244, 239, 228, 0.72);
526+
font-size: 0.94rem;
527+
line-height: 1.58;
528+
}
529+
469530
.docs-shell {
470531
min-height: 100svh;
471532
overflow-x: hidden;
@@ -751,14 +812,19 @@ h1 {
751812
.template-section,
752813
.journey-section,
753814
.docs-layout,
754-
.voice-doc-preview {
815+
.voice-doc-preview,
816+
.official-resources {
755817
grid-template-columns: 1fr;
756818
}
757819

758820
.pipeline-section {
759821
padding-bottom: 3rem;
760822
}
761823

824+
.resource-grid {
825+
grid-template-columns: 1fr;
826+
}
827+
762828
.docs-sidebar {
763829
position: static;
764830
}

apps/website/app/page.tsx

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,29 @@ const uiChecklist = [
3434
'Feed human and AI levels from useVoiceMeter or your own audio analysis.',
3535
];
3636

37+
const officialResources = [
38+
{
39+
href: 'https://www.agora.io/en/',
40+
label: 'Agora',
41+
text: 'Official Agora homepage for realtime engagement and AI products.',
42+
},
43+
{
44+
href: 'https://docs.agora.io/en/',
45+
label: 'Agora Docs',
46+
text: 'English documentation hub for Agora product setup, SDKs, and APIs.',
47+
},
48+
{
49+
href: 'https://docs.agora.io/en/realtime-media/voice',
50+
label: 'Realtime voice docs',
51+
text: 'Voice calling docs for the RTC media layer used by browser sessions.',
52+
},
53+
{
54+
href: 'https://docs.agora.io/en/ai',
55+
label: 'AI and Conversational AI docs',
56+
text: 'Agora AI docs for agent pipelines, model configuration, and runtime concepts.',
57+
},
58+
];
59+
3760
export default function HomePage() {
3861
return (
3962
<main className="site-shell">
@@ -47,6 +70,7 @@ export default function HomePage() {
4770
<a href="#package">Package</a>
4871
<a href="#deploy">Deploy</a>
4972
<a href="#ui">UI</a>
73+
<a href="#resources">Resources</a>
5074
</nav>
5175
</header>
5276

@@ -121,6 +145,24 @@ AGORA_CONVOAI_PIPELINE_ID=...`}</code></pre>
121145
<a className="text-link" href="/docs/install-voice-ring-with-shadcn">Read shadcn guide</a>
122146
</article>
123147
</section>
148+
149+
<section className="official-resources" id="resources" aria-labelledby="resources-title">
150+
<div className="resource-heading">
151+
<p className="eyebrow">Official references</p>
152+
<h2 id="resources-title">Build against Agora's English docs.</h2>
153+
<p>
154+
This project packages the Vercel and React path. Use Agora's official site and English documentation for product setup, RTC behavior, and AI agent configuration details.
155+
</p>
156+
</div>
157+
<div className="resource-grid">
158+
{officialResources.map((resource) => (
159+
<a className="resource-card" href={resource.href} key={resource.href} rel="noreferrer" target="_blank">
160+
<span>{resource.label}</span>
161+
<p>{resource.text}</p>
162+
</a>
163+
))}
164+
</div>
165+
</section>
124166
</main>
125167
);
126168
}

apps/website/app/r/registry-data.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export const registryCatalog = {
55
{
66
categories: ['voice', 'realtime', 'agent', 'vercel'],
77
description: 'A canvas-rendered voice ring button for Agora voice agents in Vercel and React apps.',
8-
docs: 'Install with `npx shadcn@latest add https://agora-realtime-agent.vercel.app/r/voice-ring-button.json`, then import `VoiceRingButton` and `useVoiceMeter` from your shadcn aliases. Homepage: https://agora-realtime-agent.vercel.app/?utm_source=shadcn-registry&utm_medium=registry-item-docs&utm_campaign=agora_voice_agents',
8+
docs: 'Install with `npx shadcn@latest add https://agora-realtime-agent.vercel.app/r/voice-ring-button.json`, then import `VoiceRingButton` and `useVoiceMeter` from your shadcn aliases. Homepage: https://agora-realtime-agent.vercel.app/?utm_source=shadcn-registry&utm_medium=registry-item-docs&utm_campaign=agora_voice_agents. Official Agora docs: https://docs.agora.io/en/',
99
files: [
1010
{
1111
path: 'packages/agora-realtime-react/src/components/voice-ring-button.tsx',

packages/agora-realtime-react/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,7 @@ The package does not store Agora credentials and does not publish AI Studio pipe
5454

5555
- Package guide: https://agora-realtime-agent.vercel.app/docs/agora-realtime-react-package
5656
- Demo and Vercel template: https://agora-realtime-agent.vercel.app/?utm_source=npm-agora-realtime-react&utm_medium=readme-docs&utm_campaign=agora_voice_agents
57+
- Agora: https://www.agora.io/en/
58+
- Agora Docs (English): https://docs.agora.io/en/
59+
- Agora realtime voice docs: https://docs.agora.io/en/realtime-media/voice
60+
- Agora AI and Conversational AI docs: https://docs.agora.io/en/ai

packages/create-agora-realtime-agent/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ Create an Agora + Vercel realtime voice agent app from the official template.
66

77
Homepage: https://agora-realtime-agent.vercel.app/?utm_source=npm-create-agora-realtime-agent&utm_medium=readme&utm_campaign=agora_voice_agents
88

9+
Official Agora resources:
10+
11+
- Agora: https://www.agora.io/en/
12+
- Agora Docs (English): https://docs.agora.io/en/
13+
- Agora realtime voice docs: https://docs.agora.io/en/realtime-media/voice
14+
- Agora AI and Conversational AI docs: https://docs.agora.io/en/ai
15+
916
## Usage
1017

1118
```bash

packages/create-agora-realtime-agent/template/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ This app was generated from the Agora realtime voice agent template.
44

55
Project homepage: https://agora-realtime-agent.vercel.app/?utm_source=create-agora-realtime-agent&utm_medium=generated-template&utm_campaign=agora_voice_agents
66

7+
Official Agora resources:
8+
9+
- Agora: https://www.agora.io/en/
10+
- Agora Docs (English): https://docs.agora.io/en/
11+
- Agora realtime voice docs: https://docs.agora.io/en/realtime-media/voice
12+
- Agora AI and Conversational AI docs: https://docs.agora.io/en/ai
13+
714
## Requirements
815

916
- Node.js compatible with Next.js 16. This template is tested from Node.js `>=20.9.0`; the source repo uses Node.js `>=24.0.0`.

0 commit comments

Comments
 (0)