pesto-students / batch-8-NuSlack

A Group-chat application
https://nu-slack.netlify.com/
2 stars 4 forks source link

Complete: Add the esdoc docs for client and server APIs #71

Closed abhi18av closed 5 years ago

abhi18av commented 5 years ago

What does this PR do?

Adds the infrastructure for ESDoc generate API documentation for the client and server codebase. Discussed over the meeting today with Patryk.

Checklist

(Go over all the following points, and put an x in all the boxes that apply.) (If you're unsure about any of these, don't hesitate to ask. We're here to help!)

Where should the reviewer start?

(Explain where the reviewer should start in order to review the whole addition or subtractions.) :checkered_flag:

How should this be manually tested?

(List of steps to reproduce, corroborate or tests to run. Write this section clear enough so that external users can also follow it and test the fix.)

  1. :one:
  2. :two:
  3. :tada:

Any background context you want to provide?

(Any information regarding the PR that the reviewer should know.) :construction:

What are the relevant tickets?

(Link to issues, related PR, JIRA issues, etc.) Closes #67

Screenshots

(Screenshots of the feature if available.) :camera:

Questions

(If available, to another developer or reviewer.) :question: