Skip to content

General form | Use of **bold**, _italic_, [links]() & code #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
iteles opened this issue Apr 7, 2015 · 3 comments
Closed

General form | Use of **bold**, _italic_, [links]() & code #14

iteles opened this issue Apr 7, 2015 · 3 comments

Comments

@iteles
Copy link

iteles commented Apr 7, 2015

I would suggest using bold, italic & code to highlight the most important information and bring interest to those long paragraphs. You want people to be able to skim them and still come away with all the useful information.

@iteles iteles changed the title General form | Use of **bold**, _italic_ & code General form | Use of **bold**, _italic_, [links]() & code Apr 7, 2015
@iteles
Copy link
Author

iteles commented Apr 7, 2015

A possible (very initial) example:
The Git for Collaboration section is aimed at the second week students of the course. Even though most of the advice in this tutorial will take a while to digest, practise is essential. A good goal is to understand all these concepts, and implement most of these tips in your collaborative projects before finishing your time as a student at Founders & Coders.

@NataliaLKB
Copy link
Owner

@iteles though I agree partially, I personally find it distracting to have too much bold or italic words . It makes it difficult for me to skim through it, rather than easier.

I may be a minority here, but that is why I chose not to do more of it.

@iteles
Copy link
Author

iteles commented Apr 13, 2015

@NataliaLKB That's fair. May be a debate that's worth having with the wider group so we can create a tutorial style guide 😉

@iteles iteles closed this as completed Apr 13, 2015
NataliaLKB pushed a commit that referenced this issue May 29, 2017
adding new command in the cheatsheet
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants