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

Website - Readme update #8712

Merged
merged 5 commits into from
Nov 25, 2024
Merged

Website - Readme update #8712

merged 5 commits into from
Nov 25, 2024

Conversation

guillim
Copy link
Contributor

@guillim guillim commented Nov 25, 2024

Readme ideas for better getting started

Website update proposal to give an easier way to get started on the Local Setup

@guillim guillim self-assigned this Nov 25, 2024
@guillim guillim marked this pull request as ready for review November 25, 2024 10:28
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

This PR enhances the documentation for the Twenty website setup process, focusing on clarity and comprehensive troubleshooting guidance across multiple files.

  • Fixed grammatical error in /packages/twenty-website/README.md line 3 ("This used for" -> "This is used for")
  • Added Redis GUI recommendation (redis insight) in /packages/twenty-website/src/content/developers/local-setup.mdx
  • Expanded troubleshooting section in /packages/twenty-website/src/content/developers/self-hosting/troubleshooting.mdx with email sending and memory error solutions
  • Clarified Postgres as mandatory requirement and added numbered setup steps in README
  • Improved Windows WSL setup instructions with detailed PostgreSQL installation steps

3 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings | Greptile

@twentyhq twentyhq deleted a comment from greptile-apps bot Nov 25, 2024
@twentyhq twentyhq deleted a comment from greptile-apps bot Nov 25, 2024
Copy link
Member

@FelixMalfait FelixMalfait left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@FelixMalfait FelixMalfait merged commit 2e2b279 into main Nov 25, 2024
19 checks passed
@FelixMalfait FelixMalfait deleted the readme branch November 25, 2024 16:26
Copy link

Thanks @guillim for your contribution!
This marks your 9th PR on the repo. You're top 4% of all our contributors 🎉
See contributor page - Share on LinkedIn - Share on Twitter

Contributions

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

Successfully merging this pull request may close these issues.

3 participants