JMTK / JMTK/d-zone-activity

Add documentation/local testing/setup info for new contributors

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue help wanted
Dominant language
TypeScript
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Started working on some step by step picture guides, but needs a lot more work and needs some official place in the README

1. Create a Discord Application
2. Open URL mappings
3. Paste in the ngrok URL of your locally hosted application
4. Copy the ID
5. Open Discord Settings
6. Go to Advanced
7. Turn on Application Test Mode
8. Paste the ID of the Discord application
9. Use `URL Origin Type` of `Discord Proxy`
10. Join a call
11. Open the activities pane
12. See d-zone

![image](https://github.com/JMTK/d-zone-activity/assets/877114/42d42851-0046-4910-91dc-07b4765be3b0)
![image](https://github.com/JMTK/d-zone-activity/assets/877114/f696305b-9157-4468-8be5-bab69830aa61)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the README and the listed Discord local-testing steps, using the existing screenshots as the guide structure. Document the setup from creating the Discord application through joining a call and opening d-zone; it is done when a new contributor can follow the official README instructions to test the activity locally.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.