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

refactor: separates firebase setup guide #23

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

achrinza
Copy link
Contributor

@achrinza achrinza commented Apr 18, 2020

Quoting from #1 (comment):

Seems like this would make the README rather long-winded. Maybe we should shift the setup guides into their own page?

This would be my suggestion:

|
L README.md
L docs
   L setup-with-gcp.md

Within the README, we could have the following to direct users to the respective docs:

Setup

Setup guides are available for these platforms:

This would help achieve 2 things:

  1. Keep the README short and sweet
    A README is meant for users to quickly glance at what the repo is about, and provide links to resources for further reading,

  2. Keep the setup guides compartmentalized
    We want to make the docs as easy to read as possible for the users. By splitting the guides according to their funtion, we can reduce the overall size of the docs and make it less daunting for new users to understand.

Signed-off-by: Rifa Achrinza [email protected]

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

Successfully merging this pull request may close these issues.

1 participant