markdown-to-slides documentation (updates on /worshops/README.md) #17

KathyLiu20 · 2020-03-31T00:13:35Z

Close issue #32

updated both the documentation for code review and for developing markdown files into slides in README.md

Issue #55 follow-up

updated README.md according to reviewers' comments

@kavuong

The 4th bullet point of issue #32 create documentation for developing markdown files into slides.

code review documentation

kavuong

Hey @KathyLiu20 thank you for your hard work! I've added some comments below.

kavuong · 2020-04-01T08:25:05Z

README.md

+
+We are specifying these details to help the design team when they put the information into the actual PPT.
+
+First, you need to specify the type -- what slide template you would like to use. Our design team has made many good BitProject templates, and you can find all of them [here](https://docs.google.com/presentation/d/1F5_Qcf_0IduoNKzRUT4owPlE5t5Ab8utmGHUMwZCM_g/edit#slide=id.p). You can make a copy of it and see the details of all templates by adding empty slides. 


some headers to designate sections would be helpful here.

kavuong · 2020-04-01T08:44:16Z

README.md

+
+
+
+Here is a full example of what a slide should be like in a markdown file.


the equivalent of this slide inside of Rochelle's slide template will really drive the point home.

kavuong · 2020-04-01T08:46:31Z

README.md

+
+# Code Review -Reviewing Markdown Cards
+
+### Checkpoints


what exactly is the context here? a bit unclear - I think the use of the title "checkpoints" is misleading

also, markdown cards are being developed based on an existing workshop or tutorial, that should be explained

kavuong · 2020-04-01T08:48:59Z

README.md

+- [ ] Each card has visuals
+- [ ] The length of each card is reasonable
+- [ ] Logical context progression from card to card
+- [ ] Using long sentences


long sentences = awkward wording here.

kavuong · 2020-04-01T08:49:45Z

README.md

@@ -3,9 +3,11 @@ All of our workshop materials - open for everyone to use!

 Our workshops are first written in Markdown, with one .md file corresponding to a slide. Each card must have the type of slide (please consult our Bit brand template) and appropriate labelings of content to be placed on the slide. 

-# How a Slide should Look
+# **Developing Markdown Cards --> PPT That Fits Inside Of Slide Template**


Context of existing activity cards -> simplified Markdown cards -> PPT slides should be explained.

taimurkashif · 2020-04-02T06:52:38Z

README.md

+
+
+
+Since the slides are to help people visualize the ideas better and be like a summary, you should simplify and extract the content from the cards instead of copying it. There should not be long sentences or paragraphs on the slides. 


I think a specific example of how one can take more in-depth information from an activity and simplify/summarize it for a slide would help the reader understand the expectations

taimurkashif · 2020-04-02T07:00:06Z

README.md

+
+
+
+Often, one card contains too much information to be covered in one slide. So you should split them up and make sure the slides are reasonable and understandable.


I think it's worth mentioning that slides have a lot of pictures and we should be mindful of this when creating slides (we don't want to overwhelm the audience with text). With that being said, when converting slides to markdown files, we shouldn't need to include all of the pictures (although still having most would be nice; we definitely want the pictures that further/clarify the concepts)

taimurkashif · 2020-04-02T07:05:29Z

README.md

+
+### Documentation for checkpoints
+
+1. The cards should have significant interactive aspect. For example, the BitBloxs games in the Postman Workshop should be included in the activity's cards. In the workshop, we can interact with students directly and verbally, then when we transfer to cards, we should try to create some interaction like steps to guide students through activities.


I think it would be beneficial to specify how the steps for explaining the interactive aspect differs from regular explanation

taimurkashif

Overall, the work was really well done! I left a few recommendations for you!

Issue #55 updates on * documentation on code view * documentation on cards --> PPT

KathyLiu20 added 3 commits March 30, 2020 17:11

markdown-to-slides-documentation (updates on /workshop/README.md)

c1816b3

The 4th bullet point of issue #32 create documentation for developing markdown files into slides.

Merge branch 'Kathy' of https://github.com/bitprj/workshops into Kathy

ec3ca9d

updats on README.md documentation for code review

9ce4261

code review documentation

kavuong requested review from kavuong and taimurkashif April 1, 2020 08:42

kavuong assigned KathyLiu20 Apr 1, 2020

kavuong reviewed Apr 1, 2020

View reviewed changes

kavuong mentioned this pull request Apr 1, 2020

Follow-up: Workshops Repository bitprj/bitproject#55

Closed

12 tasks

taimurkashif reviewed Apr 2, 2020

View reviewed changes

follow-up: updates on documentation in workshop repository

c857ead

Issue #55 updates on * documentation on code view * documentation on cards --> PPT

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

markdown-to-slides documentation (updates on /worshops/README.md) #17

markdown-to-slides documentation (updates on /worshops/README.md) #17

KathyLiu20 commented Mar 31, 2020 •

edited

Loading

kavuong left a comment

kavuong Apr 1, 2020

kavuong Apr 1, 2020

kavuong Apr 1, 2020

kavuong Apr 1, 2020

kavuong Apr 1, 2020

kavuong Apr 1, 2020

taimurkashif Apr 2, 2020

taimurkashif Apr 2, 2020

taimurkashif Apr 2, 2020

taimurkashif left a comment


		We are specifying these details to help the design team when they put the information into the actual PPT.

		First, you need to specify the type -- what slide template you would like to use. Our design team has made many good BitProject templates, and you can find all of them [here](https://docs.google.com/presentation/d/1F5_Qcf_0IduoNKzRUT4owPlE5t5Ab8utmGHUMwZCM_g/edit#slide=id.p). You can make a copy of it and see the details of all templates by adding empty slides.




		Here is a full example of what a slide should be like in a markdown file.




		Since the slides are to help people visualize the ideas better and be like a summary, you should simplify and extract the content from the cards instead of copying it. There should not be long sentences or paragraphs on the slides.




		Often, one card contains too much information to be covered in one slide. So you should split them up and make sure the slides are reasonable and understandable.


		### Documentation for checkpoints

		1. The cards should have significant interactive aspect. For example, the BitBloxs games in the Postman Workshop should be included in the activity's cards. In the workshop, we can interact with students directly and verbally, then when we transfer to cards, we should try to create some interaction like steps to guide students through activities.

markdown-to-slides documentation (updates on /worshops/README.md) #17

Are you sure you want to change the base?

markdown-to-slides documentation (updates on /worshops/README.md) #17

Conversation

KathyLiu20 commented Mar 31, 2020 • edited Loading

kavuong left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

taimurkashif left a comment

Choose a reason for hiding this comment

KathyLiu20 commented Mar 31, 2020 •

edited

Loading