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

Create skeleton.md #23

Merged
merged 1 commit into from
Jan 4, 2024
Merged

Create skeleton.md #23

merged 1 commit into from
Jan 4, 2024

Conversation

elisapaka
Copy link
Collaborator

A skeleton outline for the homepage + main tutorial sequence

A skeleton outline for the homepage + main tutorial sequence
@elisapaka elisapaka merged commit fce94d6 into main Jan 4, 2024
@elisapaka elisapaka deleted the makeitmarkdown-tutorial-skeleton branch January 4, 2024 14:55
Copy link
Member

@rufuspollock rufuspollock left a comment

Choose a reason for hiding this comment

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

See my comments in the review.

Copy link
Member

Choose a reason for hiding this comment

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

Skeleton overall looks pretty good and you have nice content already.

Main comments for me to review more:

  • skeleton is a bit too detailed for me to easily scan atm to check structure. Perhaps add a bullet pointed overview like the NextJS example summary we have in [epic] Primary tutorial that walks through creating a markdown-based website with markdown-based MOGF approach #12
  • For actual content i would focus on the early part right now where we explain why this is useful i.e. stuff like "Page 1 (Introduction to what NextJS is and why useful)" in NextJS example
  • Add some intro commentary explaining the learning goals: what will people be able to do at the end of it (or even at the end of each major section ...)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Great, thanks for the feedback!

skeleton is a bit too detailed for me to easily scan atm to check structure. Perhaps add a bullet pointed overview like the NextJS example summary we have in [epic] Primary tutorial that walks through creating a markdown-based website with markdown-based MOGF approach #12

I've added a condensed bullet-point version at the top of the skeleton.md file and have requested a review.

For actual content i would focus on the early part right now where we explain why this is useful i.e. stuff like "Page 1 (Introduction to what NextJS is and why useful)" in NextJS example

I've kept a bit more detail in this section in the condensed skeleton, and I will start from this when I begin writing out the content.

Add some intro commentary explaining the learning goals: what will people be able to do at the end of it (or even at the end of each major section ...)

Added learning goals under section called 'About this guide'.

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

Successfully merging this pull request may close these issues.

2 participants