Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic docs #77

Closed
15 tasks done
DominusKelvin opened this issue Jan 29, 2024 · 4 comments · Fixed by sailscastshq/docs.sailscasts.com#22
Closed
15 tasks done

Add basic docs #77

DominusKelvin opened this issue Jan 29, 2024 · 4 comments · Fixed by sailscastshq/docs.sailscasts.com#22
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@DominusKelvin
Copy link
Member

DominusKelvin commented Jan 29, 2024

Introduction

  • Why the name
  • Who is it for
  • What's in the stack
  • Getting started

The Basics

  • Routing
  • Navigation
  • Redirects
  • Shared data

Guides

  • Authentication
  • Authorization
  • Database
  • Email
  • Session

Deploy

  • Render

Configurations

  • Type checking JS files
@DominusKelvin
Copy link
Member Author

Hey @lennyAiko I think if I cover everything up there, I can ship a first version of the docs and then iterate on pages that are needed or make the existing ones more buoyant based on feedbacks. What do you think?

@DominusKelvin DominusKelvin pinned this issue Jan 31, 2024
@lennyAiko
Copy link
Contributor

With this it will become easier and faster to get started. Another thing we should also look at is the contents of each topic, since some info will be borrowed from other docs.

@DominusKelvin
Copy link
Member Author

With this it will become easier and faster to get started. Another thing we should also look at is the contents of each topic, since some info will be borrowed from other docs.

Yeah. I am linking out to other pages to avoid duplication of info. The goal is to present the quick getting started path in the docs and then for more in-depth folks can read in the respective docs.

CleanShot 2024-01-31 at 19 55 24@2x

@lennyAiko
Copy link
Contributor

This linking is good enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants