Documentation Plan

Goal

Pre beta

• ⛪️ Evangelize
  • Explain overall philosophy/motivations
  • Illustrate common and complex use-cases
• 🐣 Onboard users quickly
  • Make common functionality easy to grasp
• 🏃‍♂️ Help user get the most out of it
  • Explain all functionality in detail
  • Explain all interfaces
• 🎭 Help users customize it
  • Support extending, monkey-patching, etc.

Pre 1.0

• 📝 Onboard new contributors quickly
  • Quickstart guide
  • Explain concepts and goals
  • Explain architecture
  • Explain tooling
  • Explain process

Plan

• ⛪️🐣Introduce objectives
• ⛪️🐣High level API view
  • Import approaches
  • Module methods
  • Escaping
• ⛪️🐣🏃‍♂️Knex conversion examples ranging from simple replacement-only queries to complex conditional queries
  • <list queries>
• 🏃‍♂️🎭📝Document each entity with TypeDoc
  • Include version feature was added
• 🎭📝Document architecture
  • Class diagram
• 📝Document contributor process
  • [Open issue,] fork, run tests + coverage + lint, build, open PR
• 📝Document npm commands
• 📝Document build and release process
• 📝Document style guide