search

StatisticalReinforcementLearningLab / SARAv2

SARA V2
BSD 3-Clause "New" or "Revised" License
5 stars 2 forks source link

Some comments on the website #196

Open mashfiqui-rabbi opened 3 years ago

mashfiqui-rabbi commented 3 years ago

  1. Add a comment on how this page is structured. This will be very useful for others who are not familiar with Bootstrap. This doesn't have to exhaustive; just a link for people so that they can learn. e.g., the "Home" is the top of the page which is divided into two columns. "twoFatCols" css creates two columns.
    https://github.com/StatisticalReinforcementLearningLab/SARAv2/blob/e8d23d84504fa49cebfe80bceaf34c1f77c79d86/index.html#L25

  2. Then we can write a comment for "saraTitle," this is the left column of the home page. https://github.com/StatisticalReinforcementLearningLab/SARAv2/blob/e8d23d84504fa49cebfe80bceaf34c1f77c79d86/index.html#L27

  3. Can we use the following variable names: "twitter_time_line" --> "Timeline", "pageBody" --> "style_for_twitter_timeline_body", "pageTitle" --> "style_for_twitter_timeline_header". https://github.com/StatisticalReinforcementLearningLab/SARAv2/blob/e8d23d84504fa49cebfe80bceaf34c1f77c79d86/index.html#L40

If you want to use the same style for different parts of the page then we can use a generic name (big header or two_fat_column that you used.)

4. After reading the code a bit, I felt like the code would be more readable if use a snake notation. Chloe, what do you think?

ChloeL19 commented 3 years ago

Sounds great, Mash! I'll work on making these changes.