Skip to content

Commit

Permalink
docs: remove examples (#246)
Browse files Browse the repository at this point in the history
  • Loading branch information
JustinBeckwith authored Aug 26, 2024
1 parent 4659905 commit f34ae1b
Show file tree
Hide file tree
Showing 164 changed files with 986 additions and 11,957 deletions.
58 changes: 0 additions & 58 deletions .github/workflows/sdk-playground-production.yml

This file was deleted.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Read more about building Discord Activities with the Embedded App SDK on [https:
## Resources

- **[Embedded App SDK Docs](https://discord.com/developers/docs/developer-tools/embedded-app-sdk)** - Get familiar with the Embedded App SDK
- **[Activity Examples](/examples/)** - Explore examples of Discord Activities
- **[Activity Examples](https://github.com/discord/embedded-app-sdk-examples)** - Explore examples of Discord Activities
- **[Technical chat on Discord](https://discord.com/invite/discord-developers)** - Join us and other devs at DDevs at `#activities-dev-help`

## Installing this package
Expand All @@ -27,7 +27,7 @@ npm install @discord/embedded-app-sdk
To use the SDK, import it into your project and construct a new instance of the DiscordSDK class.

Below is a minimal example of setting up the SDK.
Visit [/examples/discord-activity-starter](/examples/discord-activity-starter/README.md) for a complete example application. See more info on environment variables (`YOUR_OAUTH2_CLIENT_ID`, etc...) [here](https://discord.com/developers/docs/activities/building-an-activity#find-your-oauth2-credentials).
Visit <https://github.com/discord/embedded-app-sdk-examples/tree/main/discord-activity-starter> for a complete example application. See more info on environment variables (`YOUR_OAUTH2_CLIENT_ID`, etc...) [here](https://discord.com/developers/docs/activities/building-an-activity#find-your-oauth2-credentials).

```typescript
import {DiscordSDK} from '@discord/embedded-app-sdk';
Expand Down
4 changes: 2 additions & 2 deletions docs/local-sdk-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

We have two example projects, which can be used to test the latest SDK release, as well as new changes to the SDK.

- [discord-activity-starter](/examples/discord-activity-starter) is a minimal application example
- [sdk-playground](/examples/sdk-playground) is a playground for testing any SDK functionality
- [discord-activity-starter](https://github.com/discord/embedded-app-sdk/blob/main/examples/discord-activity-starter) is a minimal application example
- [sdk-playground](https://github.com/discord/embedded-app-sdk/blob/main/examples/sdk-playground) is a playground for testing any SDK functionality

These projects consume this repo's root `@discord/embedded-app-sdk` directly via [pnpm workspaces](https://pnpm.io/workspaces)

Expand Down
5 changes: 0 additions & 5 deletions examples/.eslintrc.json

This file was deleted.

16 changes: 1 addition & 15 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,4 @@
<img src="/assets/discord-embedded-apps.svg" alt="Discord Embedded App SDK" width="500" />
<p>

### [Discord Activity Starter](/examples/discord-activity-starter)

This starter app will get you up and running quickly with the basic skeleton of an Embedded App using Node.js, React, and Vite.

### [SDK Playground](/examples/sdk-playground)

This example implements the SDK commands and events available within the application's iframe while building your app.

### [React Colyseus](/examples/react-colyseus)

This example uses Node.js, React, and [Colyseus](https://colyseus.io/), a multiplayer JS framework, to demonstrate state management in a multiplayer experience.

### [Nested Messages](/examples/nested-messages)

This example implements an Embedded App using a nested framework like a game engine. When using a game engine, you need to send messages between a parent iframe and the nested framework.
See <https://github.com/discord/embedded-app-sdk-examples/> for examples of using the Embedded App SDK.
7 changes: 0 additions & 7 deletions examples/discord-activity-starter/.gitignore

This file was deleted.

53 changes: 0 additions & 53 deletions examples/discord-activity-starter/README.md

This file was deleted.

25 changes: 0 additions & 25 deletions examples/discord-activity-starter/package.json

This file was deleted.

24 changes: 0 additions & 24 deletions examples/discord-activity-starter/packages/client/.gitignore

This file was deleted.

15 changes: 0 additions & 15 deletions examples/discord-activity-starter/packages/client/favicon.svg

This file was deleted.

13 changes: 0 additions & 13 deletions examples/discord-activity-starter/packages/client/index.html

This file was deleted.

16 changes: 0 additions & 16 deletions examples/discord-activity-starter/packages/client/package.json

This file was deleted.

This file was deleted.

Loading

0 comments on commit f34ae1b

Please sign in to comment.