Hello and welcome to this course! My name is Anthony Gore and I'll be your instructor.
In this first video, I'm going to be introducing you to the course and its contents.
Before we begin, I want to make you aware that this course is a continuation from my other course Full-Stack Vue + Node.
It doesn't matter if you haven't done that course, but, you do need to be aware that I'm going to use the same project and source code from that course.
If you were planning to do that course, I recommend you do it first and then come back to this one, as it would be a more logical order.
With that said, let's now take a look at the contents of this course.
Module 1 - API documentation with apiDoc
In the first module, we'll learn to document our backend API using a tool called apiDoc.
We're first learn to use doc blocks to document our API source code, indicating to developers the inputs and outputs of requests, the format of the data the can expect, and so on.
We can then configure apiDoc to generate a beautiful documentation site to present all this information.
Module 2 - Interactive components docs with Vue Styleguidist
In the second module, we'll be creating a component styleguide using Vue Styleguidist.
Similar to the API, we'll begin by documenting our component interfaces, including the props, events, methods and so on which we'll use to automatically generate a documentation site.
But we'll also see how to add live component previews to our docs, so our team can see exactly what our components are intended to look like.
Let's get started!