Documentation Roadmap

Things to be written

Note: some of these pages already exist, but they need to be refactored to match the new API.

• 5 step getting started tutorial
• n step advance tutorial
• neat API-DOC (30%)
• README
  • badges
    • travis ci build
    • code style
    • npm version
    • dependencies
    • code quality
  • Infographics and quick introduction
  • Test, build and contribution
• Specific pages for important concepts
  • Outgoing routes and redirect
  • Configuration
  • Server Factory
  • Service Invocation and events
  • Bootstrap functions as a best practice
• Document Plugins and additional Repositories
  • xyz-cli
    • writing a testcase
  • xyz.monitor.bootstrap
  • xyz.ping.stochastic
  • xyz.ping.swim
  • xyz.service.to.service.auth
  • xyz.example.jwt.auth
• Medium Article
  • TL;DR
  • Get our hands dirty
    • Demonstrate how important features like load-balancer (internal and external), message queue can be implemented in xyz
  • A real life example
    • Choices: email server / auth server