-
-
Notifications
You must be signed in to change notification settings - Fork 149
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
Sequelize 7 Documentation #330
Conversation
With this PR we should look into mapping old URLs to new ones (#284 (comment)) And this might be a good PR to fix the highlighted line in light mode; |
The highlight is fixed in the hooks pr :) |
Ah yes, I thought that I've seen it work properly before. There it was. Thanks! |
I think the following pages are ready for a first review (which would need to be done locally):
The rough reading order is also set:
Associations & Querying are still in progress. I don't think I'll work on the following pages in this PR:
|
Note to myself: we should document "logQueryParameters" in the section about logging |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still need to go through the associations folder and then do a quick look through the deleted files, but this is part 2 of my review
@WikiRik I believe I've implemented all requested changes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have not gone through the deleted files in detail yet, but that should not block the merging of this PR. These are my last few comments and then we should be good to merge
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One big step closer to the first v7 beta!
We still have a bunch of things to document, but I'm glad this one is behind us 😮💨 |
This PR is the start of a pretty thorough documentation rewrite. I'm planning on rewriting in this PR:
sequelize.sync
, not migrations) tablesFollow-up PRs:
Not planned in this PR:
This PR is a complete re-organization of our structure. I'm attempting to write it in the order a new user would normally follow:
Each one is a chapter that can contain both basic and advanced topics. They're easier to find when they're grouped by a theme (e.g. defining models) rather than "basic topics and advanced topics" (like we currently have where defining models is in one place but the data types are in a completely different place)
I'm also going for TypeScript-first as much as possible