The documentation

Summary

To complement The Boring JavaScript Stack, good documentation is essential for a great developer experience (DX). The documentation is available at docs.sailscasts.com/boring-stack and serves as a reference material whenever you need guidance.

While this course includes detailed videos and an accompanying codebase, having well-maintained docs ensures that information is always accessible. The documentation will continue to evolve over time, adding:

• More deployment options.

• Additional guides.

• More foundational explanations.

Even though The Boring Stack is simple enough that you might not always need the docs, they serve as a trusted reference for topics like routing, configuration, and deployment. The docs should be your go-to resource whenever you have doubts.

Additionally, if you notice missing information, you can submit an issue or even contribute a pull request (PR) to improve the docs.

Key takeaway: Bookmark the docs—they will accompany you on your journey to building great full-stack applications with The Boring JavaScript Stack.

Transcript

Introduction

To wrap up this chapter, I want to introduce you to a great supplement for The Boring JavaScript Stack: the documentation.

I firmly believe that great technology deserves great documentation because it significantly improves the developer experience (DX).

You can find the documentation at docs.sailscasts.com/boring-stack. It serves as a reference material whenever you need guidance.

Why Good Documentation Matters

Of course, in this course, you will have detailed videos—I think there will be around 50 chapters covering everything exhaustively.

You’ll also have access to the codebase. But good documentation never hurts—it’s always helpful to have a written reference that you can quickly check.

What’s Inside the Docs?

If you visit the documentation, you’ll see a Getting Started section and many useful guides.

And here’s the best part:

• The docs will evolve over time as we add more content.

• Expect new deployment methods, additional guides, and more foundational topics to be covered.

It’s a living resource, meant to support you as you build with The Boring JavaScript Stack.

When Should You Use the Docs?

Honestly, the stack is simple enough that you might not always need the documentation.

But whenever you need to reference something, chances are it's already covered in the docs.

For example:

• Routing in The Boring Stack – If you need to know how to set up routes, you can check the docs.

• Configuration files – You’ll find explanations on how things work.

• Common patterns and best practices – The docs act as an evergreen guide.

Whenever you’re in doubt, go to the docs first before searching elsewhere.

Other Support Options

Aside from the documentation, you can also:

• Ask questions in the community.

• Refer to the videos for deeper explanations.

However, the documentation should be your first stop whenever you want to self-solve problems.

Contributing to the Docs

If you ever find something missing in the docs, you can:

1. Submit an issue at docs.sailscasts.com to request additional content.

2. Make a pull request (PR) if you want to contribute directly (after creating an issue first).

Conclusion

So that’s it—the documentation is your support material.

If this is your first time using The Boring JavaScript Stack, there will be some learning curve (not much, but still something).

To make your journey smoother, always reference the docs at docs.sailscasts.com/boring-stack.

They will accompany you as you build great, awesome full-stack applications with The Boring JavaScript Stack!