synchub.to
mirror your GitHub repos to tangled.org automatically synchub.to
mirror sync tangled github git
Star 114
Fork 3
Watch

docs: improve setup documentation for clarification #29

Merged danielroe.dev
targeting main from felixs.dev/danielroe.dev-synchub.to:docs/setup-clarification
Merged opened by and assigned to danielroe.dev
targeting main from felixs.dev/danielroe.dev-synchub.to:docs/setup-clarification

Description #

While setting up the project locally, I had a few confusing steps, which I would like to ease for new contributors in the future:

  • GitHub app webhook needs to be setup before configuring the event subscriptions
  • the app needs to be public in order to see the selection screen of where to install the app (otherwise only possible in your own account)
  • more intuitive order of operations: start with neon and smee to get webhook URL and db connection string, then all GitHub app configs are already known and only then, start with .env file creation. Last but not least, you can run the migration command.
  • add clear instructions to have 3 terminals open

I know that it adds way more docs than technically necessary, but I believe that new contributors would really benefit from this.

Commits 0