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

feat: ✨ Add new chapters #1

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jakansha2001
Copy link

add 2 new chapters:

  • working with endpoints

  • working with models

  • Add new slides to existing chapters

  • Add presenter notes to all chapters

add 2 new chapters:
- working with endpoints
- working with models

- Add new slides to existing chapters
- Add presenter notes to all chapters
Copy link
Contributor

@vlidholt vlidholt left a comment

Choose a reason for hiding this comment

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

This is a really good start to the slides, so don't feel discouraged by the many comments. :)

Overall, there are a few things that need to be fixed. There are not comments for all places these things appar, so you will need to go through everything and make sure it is consistent:

  • Make sure to be consistent with formatting and punctuation across all slides.
  • Sometimes there are lists, sometimes bullets, and sometimes there are multiple paragraphs for similar types of comments. I suggest we make it consistently just paragraphs.
  • Sometimes there are double line breaks, sometimes single line breaks.
  • Consistently use the markdown code ticks to mark keywords and filenames. (Now there is a mix between ticks, double quotes, and no quotes.)

The writing style is also quite different across slides. Everything need to be in the same style of writing. The notes should work as a spoken script to narrate the slides.

.DS_Store Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

This file should not be version controlled.

Copy link
Contributor

Choose a reason for hiding this comment

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

This file should not be version controlled.

Copy link
Contributor

Choose a reason for hiding this comment

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

This file shouldn't have been added to version control in the first place (my misstake!).

Let's remove this file (and the other similar ones), and add all the files that shouldn't be version controlled to the .gitignore file.

@@ -1,6 +1,9 @@
import 'package:slick_slides/slick_slides.dart';

const String presenterNotesOverviewTitleSlide =
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this would be better as a local variable (add a leading underscore).

Let's also change for all similar places. :)

@@ -4,9 +4,24 @@ import 'package:flutter_svg/svg.dart';
import 'package:shared/shared.dart';
import 'package:slick_slides/slick_slides.dart';

const String presenterFeaturesAllNotes =
'''Serverpod comes with a complete database migration system that helps you apply and version changes to the database.
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's move this to the previous slide as it belongs with the ORM.


When using copyWith, any field you don't update remains unchanged in the new object.''';

const _serializedCode = '''var john = User(name: 'John Doe', age: 25);
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we need to flesh this out with more examples. Explaining how the copy with null works, etc. (We may need to do this in the docs too).

import 'package:shared/shared.dart';
import 'package:slick_slides/slick_slides.dart';

const String presenterToFromJson = '''The toJson and fromJson methods are generated on all models to help with serialization.
Copy link
Contributor

Choose a reason for hiding this comment

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

The text here needs to explain that we are looking at the generated code.

import 'package:slick_slides/slick_slides.dart';

const String presenterCustomMethods =
'''Sometimes you wish to add custom methods to the generated classes in Serverpod.
Copy link
Contributor

Choose a reason for hiding this comment

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

This text also need to be fleshed out a bit. Perhaps explaining that you cannot extend the class, but instead use extensions to add extra functionality, etc.

import 'package:shared/shared.dart';
import 'package:slick_slides/slick_slides.dart';

const String presenterNotes = 'This would be the presenter notes for this slide.';
Copy link
Contributor

Choose a reason for hiding this comment

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

Really need to add some notes for this slide. Even better, it would be good to mention that there are more features supported by the models and where you can find the full documentation for these (or that they will be explained in later slides).

content: Column(
children: [
Expanded(
child: Image.asset(
Copy link
Contributor

Choose a reason for hiding this comment

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

The layout of this slide doesn't look 100% to me. There may be a bit too much info, and the text is very small.

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