-
Notifications
You must be signed in to change notification settings - Fork 758
Re-write getting started docs #1334
Re-write getting started docs #1334
Conversation
|
||
**Share what you know** Give a talk in school, work, or a local meetup. I'm willing to bet your audience will not know the debugger is a web app! | ||
|
||
- here are @amitzur's [slides](https://docs.google.com/presentation/d/1jdnvL-BwwxEuFbb9tiRxcT6UT-Ua0jGhy9FKBT4b43E/edit) from his [talk](https://twitter.com/amitzur/status/790153843946426369) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@clarkbw i think your slides could be good here too
|
||
```bash | ||
yarn run chrome | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🌟 @Garbee I think you'll like this!
* [linux](https://github.com/devtools-html/debugger.html/issues/1082) | ||
|
||
|
||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ughh, meant to have some context here. not sure if we need the same linux details
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks like good changes. 👍
@@ -1,6 +1,6 @@ | |||
# debugger.html | |||
# Debugger.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why the caps? We've always gone lowercase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
haha - yeah, wanted to have a conversation about and hear why. sorry forgot to comment
@@ -0,0 +1,22 @@ | |||
const spawn = require('child_process').spawn; | |||
|
|||
const chromeBinary = "/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe a note or file a followup issue to get Windows working.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good point
|
||
```bash | ||
npm i -g [email protected] | ||
g clone [email protected]:devtools-html/debugger.html.git |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
git clone
|
||
#### Starting Firefox | ||
|
||
If you're looking for an alternative to `yarn run firefox`, you have two options: cli, gcli. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you might have skipped the GCLI option below.
3128e10
to
6a3b393
Compare
@@ -35,126 +25,19 @@ We respect your time and want to help you make the most of it as you learn more | |||
* [Configuration](#configuration) | |||
* [Create a local config file](#create-a-local-config-file) | |||
* [Issues and Pull Request labels](#issues-and-pull-requests) | |||
[Project Overview](#sd) | |||
[What should I know before I get started?](#what-should-i-know-before-i-get-started) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not necessary
91d6c07
to
178a666
Compare
1. add getting started 2. add first activity 3. consolidate contributing 4. consolidate readme
178a666
to
c69b36c
Compare
Associated Issue: #1233
Overview
We've gotten lots of feedback on our getting started docs. Here are some takeaways
Summary of Changes
Test Plan
CC @Garbee, @clarkbw, @viswanathamsantosh