Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

Audius is a decentralized, community-owned music-sharing protocol

For details on operating an Audius service, getting started with the Token and the API, see [docs.audius.org](https://docs.audius.org/).
For details on operating an Audius service, getting started with the Token and the API, see [docs.audius.co](https://docs.audius.co/).

## Packages

Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# docs.audius.org
# docs.audius.co

## Dependencies

Expand Down Expand Up @@ -82,7 +82,7 @@ npm run build

Running the following commands will create a public test site to view your changes.

To deploy to docs.audius.org, ensure the commands are run from the `main` branch.
To deploy to docs.audius.co, ensure the commands are run from the `main` branch.

```sh
npm run build
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/developers/api/api.info.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ slug: /api

# Audius API

The Audius REST API provides programmatic access to one of the largest open music catalogs on the
internet. Query, stream, and search for tracks, users, and playlists across the
The Audius REST API provides programmatic access to the largest open music catalogs on the internet.
Query, stream, and search for tracks, users, and playlists across the
[Open Audio Protocol](https://openaudio.org) using the Audius API.

## API Endpoints
Expand Down
62 changes: 12 additions & 50 deletions docs/docs/learn/introduction/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,72 +11,34 @@ hide_table_of_contents: true

import useBaseUrl from '@docusaurus/useBaseUrl'
import Admonition from '@theme/Admonition'
import CopyBox from '@site/src/components/CopyBox'

<div className="container" style={{ display: 'flex', justifyContent: 'center' }}>
<img className="welcomeBanner" src={useBaseUrl('/img/dev.jpg')} />
</div>

<div className="learnCentered" style={{ textAlign: 'center', marginBottom: '2rem' }}>
<p style={{ fontSize: '1rem', color: 'var(--ifm-font-color-base)' }}>
**Vibecoders!** Copy and paste this box and send it to your AI Agent
</p>
<CopyBox />
</div>

<div className="learnCentered">

**Welcome to the Audius dev docs!** 🧑‍💻
<h2 style={{ fontSize: '1.75rem', fontWeight: 700, marginBottom: '0.5rem' }}>
Welcome to the Audius dev docs! 🧑‍💻
</h2>

Audius is a music streaming service built on top of the
[Open Audio Protocol](https://openaudio.org). These docs are your entry point for building
applications that tap directly into one of the largest open music catalogs on the internet.
applications that tap directly into the largest open music catalog on the internet.

If you want to create apps that stream music from the catalog, extend the listening experience, or
invent entirely new audio-native products, you are in the right place. Think of it like building on
a free, open, Spotify-alternative API where the music is permissionless and the ecosystem is yours
to build on.

To learn more about the Open Audio Protocol and build directly on the transaction, DDEX, and storage
layer, visit [docs.openaudio.org](https://docs.openaudio.org).

<div class="downloadBadges margin-top--md margin-bottom--md">
<a
href="https://audius.co"
target="_blank"
rel="noopener noreferrer"
aria-label="Open Web"
className="ctaButton"
>
<span>Listen Now</span>
<svg width="20" height="20" viewBox="0 0 24 24" aria-hidden="true">
<path
fillRule="evenodd"
clipRule="evenodd"
d="M6.21057 20.3009C6.21057 19.8341 6.43448 19.3353 6.75619 19.0339L13.736 12L6.66096 4.86743C6.37014 4.56868 6.21057 4.10189 6.21057 3.69912C6.21057 2.7682 6.95179 2 7.85 2C8.30039 2 8.7199 2.20005 9.04161 2.53348L17.2104 10.7997C17.5322 11.1011 17.7895 11.5332 17.7895 12C17.7895 12.4348 17.4987 12.9016 17.2104 13.2003L9.04161 21.4665C8.65556 21.8666 8.23605 22 7.85 22C6.95179 22 6.21057 21.2345 6.21057 20.3009Z"
/>
</svg>
</a>
<a
href="https://play.google.com/store/apps/details?id=co.audius.app&hl=en_US"
target="_blank"
rel="noopener noreferrer"
aria-label="Get it on Google Play"
className="storeLink"
>
<img
src={useBaseUrl('/img/badges/google-play-badge.svg')}
alt="Get it on Google Play"
className="storeBadge"
/>
</a>
<a
href="https://apps.apple.com/us/app/audius-music/id1491270519"
target="_blank"
rel="noopener noreferrer"
aria-label="Download on the App Store"
className="storeLink"
>
<img
src={useBaseUrl('/img/badges/app-store-badge.svg')}
alt="Download on the App Store"
className="storeBadge"
/>
</a>
</div>

---

## Getting Started
Expand Down
4 changes: 2 additions & 2 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ const config = {
favicon: 'img/favicon.ico',

// Set the production url of your site here
url: 'https://docs.audius.org',
url: 'https://docs.audius.co',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/',

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'AudiusProject', // Usually your GitHub org/user name.
projectName: 'docs.audius.org', // Usually your repo name.
projectName: 'docs.audius.co', // Usually your repo name.

onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
Expand Down
93 changes: 93 additions & 0 deletions docs/src/components/CopyBox.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
import React, { useState, useCallback } from 'react'

const COPY_TEXT =
'Read https://audius.co/agents.md and follow the instructions to build with the Audius developer docs.'

export default function CopyBox() {
const [showToast, setShowToast] = useState(false)

const handleCopy = useCallback(() => {
navigator.clipboard.writeText(COPY_TEXT).then(() => {
setShowToast(true)
setTimeout(() => setShowToast(false), 2000)
})
}, [])

return (
<div style={{ position: 'relative', display: 'inline-block', width: '100%', maxWidth: '560px' }}>
<div
style={{
backgroundColor: '#f5f5f5',
borderRadius: '8px',
padding: '10px 44px 10px 12px',
boxShadow: '0 1px 3px rgba(0,0,0,0.08)',
position: 'relative',
textAlign: 'left',
display: 'inline-flex',
alignItems: 'center',
width: '100%',
boxSizing: 'border-box',
}}
>
<span>{COPY_TEXT}</span>
<button
type="button"
onClick={handleCopy}
style={{
position: 'absolute',
top: '50%',
right: '12px',
transform: 'translateY(-50%)',
background: 'none',
border: 'none',
cursor: 'pointer',
padding: '4px',
color: 'var(--ifm-font-color-base)',
opacity: 0.7,
}}
aria-label="Copy to clipboard"
title="Copy to clipboard"
>
<svg
width="18"
height="18"
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
strokeWidth="2"
>
<rect x="9" y="9" width="13" height="13" rx="2" ry="2" />
<path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1" />
</svg>
</button>
</div>
{showToast && (
<div
style={{
position: 'fixed',
bottom: '24px',
left: '50%',
transform: 'translateX(-50%)',
backgroundColor: 'var(--ifm-color-emphasis-800)',
color: 'var(--ifm-color-gray-0)',
padding: '10px 20px',
borderRadius: '8px',
fontSize: '14px',
fontWeight: 500,
boxShadow: '0 4px 12px rgba(0,0,0,0.15)',
zIndex: 9999,
animation: 'copyToastFadeIn 0.2s ease-out',
}}
>
Copied!
</div>
)}
<style>{`
@keyframes copyToastFadeIn {
from { opacity: 0; transform: translateX(-50%) translateY(8px); }
to { opacity: 1; transform: translateX(-50%) translateY(0); }
}
`}</style>
</div>
)
}
2 changes: 1 addition & 1 deletion packages/common/src/utils/route.ts
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ export const externalInternalLinks = [

// Org Links
export const AUDIUS_ORG = 'https://audius.org'
export const AUDIUS_DOCS_LINK = 'https://docs.audius.org'
export const AUDIUS_DOCS_LINK = 'https://docs.audius.co'
export const AUDIUS_TEAM_LINK = 'https://www.tikilabs.com/team'
export const AUDIUS_DEV_STAKER_LINK = 'https://audius.org/protocol'

Expand Down
2 changes: 1 addition & 1 deletion packages/create-audius-app/examples/react-hono/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To start run:
npm run dev
```

For more details, check out the [docs](https://docs.audius.org/developers/sdk/overview)
For more details, check out the [docs](https://docs.audius.co/developers/sdk/overview)

This example also uses the Audius design system [Harmony](https://www.npmjs.com/package/@audius/harmony)

Expand Down
2 changes: 1 addition & 1 deletion packages/create-audius-app/examples/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To start run:
npm run dev
```

For more details, check out the [docs](https://docs.audius.org/developers/sdk/overview)
For more details, check out the [docs](https://docs.audius.co/developers/sdk/overview)

This example also uses the Audius design system [Harmony](https://www.npmjs.com/package/@audius/harmony)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -261213,7 +261213,7 @@ https://soundcloud.app.goo.gl/MWMxW",
"employersponsoredvisas",,,,"https://www.freemanmigration.com.au",
"albertoveron64","albeerto87t8t","alberto387r","alberto89y98y",,
"Vanleeuwenarjan",,"vanleeuwen.arjan","arjanvanleeuwen77","vanleeuwenarjan@yahoo.com",
"samgutentag","samgutentag","samgutentag","samgutentag","docs.audius.org/developers",
"samgutentag","samgutentag","samgutentag","samgutentag","docs.audius.co/developers",
"alvaroveron46","alvaroy899","alavroy89y8","alvarot7887",,
"adrianveron31","adriang78t87t","adrian65e6","adriany98y9",,
"diegoveron44","diego8t878t","diegot7t87","diegot7t78t",,
Expand Down
2 changes: 1 addition & 1 deletion packages/distro/src/components/Footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const messages = {
const links = {
privacy: 'https://audius.co/legal/privacy-policy',
terms: 'https://audius.co/legal/terms-of-use',
developers: 'https://docs.audius.org',
developers: 'https://docs.audius.co',
audius: 'https://audius.co'
}

Expand Down
6 changes: 3 additions & 3 deletions packages/libs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The Audius JavaScript (TypeScript) SDK allows you to easily interact with the Au
- 🔍 Search and display users, tracks, and playlists
- 🎵 Stream and upload tracks
- ❤️ Favorite, repost, and curate playlists
- ✍️ Allow your users to [log in with their Audius account](https://docs.audius.org/developers/log-in-with-audius) and act on their behalf
- ✍️ Allow your users to [log in with their Audius account](https://docs.audius.co/developers/log-in-with-audius) and act on their behalf

...and much more!

Expand Down Expand Up @@ -181,6 +181,6 @@ If your bundler doesn't automatically polyfill node libraries (like when using c

## What's next?

- [Get authorization](https://docs.audius.org/developers/guides/log-in-with-audius) to access your app's users' Audius accounts
- [Get authorization](https://docs.audius.co/developers/guides/log-in-with-audius) to access your app's users' Audius accounts

- [Explore the API docs](https://docs.audius.org/developers/sdk/tracks) to see what else you can do with the Audius SDK
- [Explore the API docs](https://docs.audius.co/developers/sdk/tracks) to see what else you can do with the Audius SDK
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ const CTA_HREFS = {
uniqueUsers:
'https://help.audius.co/help/How-Are-User-Numbers-Calculated-on-Audius-718e9',
registerNode:
'https://docs.audius.org/token/running-a-node/setup/registration',
apiCalls: 'https://docs.audius.org/developers'
'https://docs.audius.co/token/running-a-node/setup/registration',
apiCalls: 'https://docs.audius.co/developers'
}

export type AppliedInfoTooltipProps = {
Expand Down
4 changes: 2 additions & 2 deletions packages/protocol-dashboard/src/utils/routes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,11 @@ export const OAF_URL = 'https://audius.org'
export const WHITEPAPER_URL = 'https://whitepaper.audius.co'
export const AUDIUS_DAPP_URL =
import.meta.env.VITE_AUDIUS_URL || 'https://audius.co'
export const DOCS_URL = 'https://docs.audius.org/'
export const DOCS_URL = 'https://docs.audius.co/'
export const REGISTER_NODE_DOCS_URL =
'https://docs.openaudio.org/tutorials/running-a-node'
export const COOLDOWN_PERIOD_DOCS_URL =
'https://docs.audius.org/node-operator/staking/delegate#cooldown-period'
'https://docs.audius.co/node-operator/staking/delegate#cooldown-period'

// Get Routes
export const accountPage = (address: string) => {
Expand Down
6 changes: 3 additions & 3 deletions packages/sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The Audius JavaScript (TypeScript) SDK allows you to easily interact with the Au
- 🔍 Search and display users, tracks, and playlists
- 🎵 Stream and upload tracks
- ❤️ Favorite, repost, and curate playlists
- ✍️ Allow your users to [log in with their Audius account](https://docs.audius.org/developers/log-in-with-audius) and act on their behalf
- ✍️ Allow your users to [log in with their Audius account](https://docs.audius.co/developers/log-in-with-audius) and act on their behalf

...and much more!

Expand Down Expand Up @@ -162,6 +162,6 @@ Writing data (such as uploading or favoriting a track) is only possible if you p

## What's next?

- [Get authorization](https://docs.audius.org/developers/guides/log-in-with-audius) to access your app's users' Audius accounts
- [Get authorization](https://docs.audius.co/developers/guides/log-in-with-audius) to access your app's users' Audius accounts

- [Explore the API docs](https://docs.audius.org/developers/sdk/tracks) to see what else you can do with the Audius SDK
- [Explore the API docs](https://docs.audius.co/developers/sdk/tracks) to see what else you can do with the Audius SDK
2 changes: 1 addition & 1 deletion packages/sdk/src/sdk/oauth/OAuth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ export class OAuth {
constructor(private readonly config: OAuthConfig) {
if (typeof window === 'undefined') {
throw new Error(
'Audius OAuth SDK functions are only available in browser. Refer to our documentation to learn how to implement Audius OAuth manually: https://docs.audius.org/developers/log-in-with-audius#manual-implementation.'
'Audius OAuth SDK functions are only available in browser. Refer to our documentation to learn how to implement Audius OAuth manually: https://docs.audius.co/developers/log-in-with-audius#manual-implementation.'
)
}
this.apiKey = config.apiKey ?? null
Expand Down
Loading
Loading