Ideas on improving the documentation

Open
#65 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
15/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Start by reviewing the documentation repository and the linked Sequelize pull request and sequelize-it project for the proposed improvements. Confirm which documentation changes are selected, then define completion as implementing the agreed improvements and updating the relevant website documentation.

Written by the indexing model from the issue text.

Description

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

Feel free to add more in the comments

Dominant language
HTML
Stars
30
Forks
170
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sequelize/website

All issues in sequelize/website

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.