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

Improve lecture descriptions #15

Open
LeonMatthes opened this issue Sep 10, 2018 · 2 comments
Open

Improve lecture descriptions #15

LeonMatthes opened this issue Sep 10, 2018 · 2 comments
Assignees
Labels
improvement Improvement to an existing, working feature

Comments

@LeonMatthes
Copy link
Collaborator

Possible improvements include:

  • Linking more methods and classes for easier navigation
  • Check for "advanced" terminlogy that a newcomer might not understand
  • Clearly state the goals of the lectures
@LeonMatthes LeonMatthes self-assigned this Sep 10, 2018
@LeonMatthes LeonMatthes added the improvement Improvement to an existing, working feature label Sep 10, 2018
@LeonMatthes
Copy link
Collaborator Author

LeonMatthes commented Sep 10, 2018

Started reworking the lecture descriptions
New rules for formatting the lecture descriptions:

  • The first line is the title and bold
  • Add a new line after a
    tag to reflect later HTML formatting
  • Link any classes/methods that are relevant for the lecture
  • Code snippets should be surrounded by double quotes " and be italic (ex.: "Morph new")
  • If appropriate, add an empty line between additional information and the lectures acceptance criteria

This also means removing any left italics formatting from class names, which was inconsistent anyway

@LeonMatthes
Copy link
Collaborator Author

Linking and clear goal statement have been adressed.
Should check with Squeak newcomers for advanced terminology as it is difficult to judge without more information about the target group

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improvement to an existing, working feature
Projects
None yet
Development

No branches or pull requests

1 participant