website icon indicating copy to clipboard operation
website copied to clipboard

Ideas on improving the documentation

Open WikiRik opened this issue 3 years ago • 2 comments
trafficstars

Just so we won't forget about it, these are some ideas that we could use to improve the docs;

  • From @ajbraus comes https://github.com/sequelize/sequelize/pull/13185 and https://github.com/ajbraus/sequelize-it

Feel free to add more in the comments

WikiRik avatar Apr 04 '22 23:04 WikiRik

I've started working on a full rewrite of the documentation with the following principles:

  • Have TypeScript versions of our examples where relevant
  • Avoid relegating important topics to "Other topics". e.g. "DataTypes" should be near model definition
  • Go into depth with each topic (One such example is also DataTypes which I already cherry-picked to the new docs)
  • Document things we see users struggle with

This is where I'm at, huge WIP

├── associations
│   ├── advanced-topics.mdx
│   ├── _belongs-to-methods.mdx
│   ├── _category_.json
│   ├── many-to-many.mdx
│   ├── one-to-many.mdx
│   ├── one-to-one.mdx
│   └── overview.md
├── getting-started.mdx
├── intro.mdx
├── models
│   ├── associations-2.md
│   ├── auto-timestamps.mdx
│   ├── _category_.json
│   ├── datatypes.md
│   ├── defining-a-model.mdx
│   ├── paranoid.md
│   └── sql-name-inference.mdx
├── model-synchronization.md
├── querying
│   ├── associations.mdx
│   └── _category_.json
└── terminology.md

ephys avatar Apr 05 '22 06:04 ephys

Don't know about https://ajbraus.github.io/sequelize-it

I will take a look on his website to find something interesting I can provide here.

fzn0x avatar Oct 26 '22 10:10 fzn0x