Restructure documentation

[dickermoshe]

@simolus3 Check these as we go along with this I'll be adding checkboxes once more docs are completed.

Schema

• I simplified the datetime stuff. I will put the detailed explanation on datetime migrations on another page
• Indexes will have their own page
• Relations will have their own page
• Row Classes will have their own page
• Added more examples
• Added a overview to the page
• put some stuff in advance
• Made clientDefault the recommended way to to defaults

@simolus3 -> for you to check when satisfied:

• [ ] Schema.md looks great !!!

[dickermoshe]

@simolus3 Seems docker is failing. Don't know if this is a github, docker or Drift issue.

[simolus3]

Maybe Docker Hub is rate-limiting unauthenticated GitHub actions? If the problem persists we might have to use another registry for the dependencies.

[dickermoshe]

We could try this

[github-actions[bot]]

🚀 Deployed on https://deploy-preview-3246--moor.netlify.app

[dickermoshe]

Seems docker is working again

[dickermoshe]

Some comments on the schema page. It reads really nicely, I think my biggest question is what role this page should have (at the moment, part of it read like an in-depth reference, parts read like a getting started guide for people who have never used drift or build runner). The docs need to be good for both, but I think it will be hard to reconcile this on a single page.

The more I think about this, the more I'm convinced you're right. I'm going to put this on hold until I have a better plan of action.

[dickermoshe]

The focus of this restructuring is mainly for the 5 or 6 pages that users will go to when they discover drift. There is some legacy stuff which will confuse new users (sqlflite) which should be explained better.

Overall the docs are pretty ok. I'm focusing mostly on PR, while you're focusing on maintaining a high quality package. Geez, get better priorities man😉

[simolus3]

The focus of this restructuring is mainly for the 5 or 6 pages that users will go to when they discover drift.

Maybe we could duplicate some of the information and restructure contents into a "reference" section (basically what we have at the moment) and a guide section that has the setup and these friendlier/high-level introductions to common things like tables, references and row classes. Then at the top of each page we'd put a box saying "This page gives an introduction to tables for users exploring drift. For a complete reference see, link1, link2, link3." (and similarly the reference pages could link to the guides).

[dickermoshe]

Instead of reinventing the wheel, I'm going to copy drizzle structure

[dickermoshe]

@simolus3 Can we add this

mixin IdColumnMixin on Table {
  late final id = integer().autoIncrement()();
}

to drift?

Or maybe as a base class

class TableWithId extends Table {
  late final id = integer().autoIncrement()();
}

Maybe we could call it something better though.

[dickermoshe]

Closing. We're going to do this a single page at a time until everything is nice.

[dickermoshe]

If Celest starts to take off, we're going to be overrun with new users. Let's try to get this done quicker

[simolus3]

Let's try to get this done quicker

Agreed :+1 I've responded to your message, let me know if there's anything else I can do to help here :) I can also help with examples or writing sections once we have a good understanding on how to structure things.