Skip to content
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

Tips and Tricks Main Chapter Landing page #17

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

chuanhao01
Copy link
Contributor

I was thinking of making this chapter more modular, where the main chapter's README contains the links and a short description of the tips. Also included a way to credit the tip's author (May or may not be necessary?)
Also adding a section on how to contribute a tip.

Decided this should be a separate PR from actually adding a tips and tricks sub-chapter.

Let me know what you think of the format so far @woojiahao.

@woojiahao woojiahao self-requested a review September 27, 2020 08:11
@woojiahao woojiahao added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed question Further information is requested labels Sep 27, 2020
@woojiahao
Copy link
Owner

I like that each author is given credit for their work. I don't have any issues with the current format. If we're making the pages modular, there'll be adjustments that will have to be made to the site

@chuanhao01
Copy link
Contributor Author

chuanhao01 commented Sep 27, 2020

I like that each author is given credit for their work. I don't have any issues with the current format. If we're making the pages modular, there'll be adjustments that will have to be made to the site

Hmm I guess we could do that, although I think we can leave it as it is for now.
Cause I was thinking the quick reference links would be more people using markdown.
This was based on chapter 7, because you can see all the subchapters on the website already.

Was also gonna ask this about the chapter 7 sub-chapters as well

image

Honestly, I don't think its too big of a deal if the website is left as is.
Maybe later on when there is more time :D

@woojiahao
Copy link
Owner

Yup chapter 7 works already, but from my impression, I thought you were going to make small markdown files per tip and link them in the main README. Which in this case, would not register as a chapter. But we can always make it a chapter. The site already handles sub-chapters

@chuanhao01
Copy link
Contributor Author

chuanhao01 commented Sep 28, 2020

Just added:

  • Adding tips as Sub-chapter requirements
  • Date Completed section in tips quick reference table
    • Date Completed section requirements are also added

@woojiahao
Copy link
Owner

woojiahao commented Oct 23, 2020

Oops, sorry, been really busy lately 😬 I'll take a look through this tonight and share my comments here! Thank you for the good work @chuanhao01 👍🏻

Copy link
Owner

@woojiahao woojiahao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good but there are some minor changes that can be made! Good work! 😄

09-tips-and-tricks/README.md Outdated Show resolved Hide resolved
09-tips-and-tricks/README.md Outdated Show resolved Hide resolved
09-tips-and-tricks/README.md Outdated Show resolved Hide resolved
Minor changes for TIps and Tricks Main chapter's folder

Co-authored-by: Woo Jia Hao <[email protected]>
@chuanhao01
Copy link
Contributor Author

Hey just got around to looking at the changes from a week ago.
Alot of things just piled up for next week, so I think commits are going to slow down for a bit. 😆 (There are like some comps and assignments)
Hope you don't mind.

@woojiahao
Copy link
Owner

woojiahao commented Oct 31, 2020

No worries at all! Let's take this slow and just work on this whenever is best 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants