Proposal for Streamlining the Onboarding Process and Enhancing Documentation Clarity

[yihong1120]

Dear Highstorm Maintainers,

I trust this message finds you well. I am writing to you today as an enthusiastic user and prospective contributor to the Highstorm project. Upon reviewing the project's documentation, I have identified a couple of areas where I believe enhancements could significantly improve the onboarding experience for new contributors and provide greater clarity in the setup instructions.

Firstly, I would like to suggest the implementation of a more detailed onboarding guide that encompasses common pitfalls and troubleshooting steps. This guide could be particularly beneficial for contributors who may encounter issues when setting up the various third-party services required by Highstorm.

Secondly, the current documentation assumes a level of familiarity with the services like Planetscale, Tinybird, Upstash, and Clerk. While these services are indeed integral to the project, a brief introduction or overview of each service's role within Highstorm could aid contributors in understanding the architecture and the workflow of the project more comprehensively.

To this end, I propose the following enhancements to the README.md and the project documentation:

1. Expanded Onboarding Guide: A dedicated section that walks new contributors through the setup process step-by-step, including screenshots and a FAQ section to address common issues.

2. Service Overviews: A brief description of each third-party service, highlighting its purpose and how it integrates into the Highstorm ecosystem. This could be included in the 'Services' section of the README.md.

3. Environment Variable Clarification: Additional comments in the .env.example file to explain the significance of each variable and provide guidance on where to find the necessary information.

4. Prisma and Tinybird Setup: A more detailed explanation of the Prisma and Tinybird setup processes, potentially with a link to external resources or official documentation for users unfamiliar with these tools.

5. Onboarding Endpoint: Clarification on the purpose of visiting the /onboarding endpoint post-signup, and what actions a user should expect to take once there.

I am more than willing to assist in the drafting and implementation of these enhancements, should you find them to be beneficial for the project. I believe that by making these improvements, we can make Highstorm even more accessible and welcoming to new contributors, thereby fostering a more vibrant and collaborative community.

Thank you for considering my suggestions. I am looking forward to your feedback and the opportunity to contribute to Highstorm's success.

Best regards,
yihong1120

[chronark]

Please see the top of the readme, I'm not longer able to maintain this and am focusing my efforts on other open source projects

[pzehle]

@chronark I understand that you have no obligation to maintain the project since it is open-source. However, I do believe you should remove the pricing section of the website and stop selling the product if it is in fact a "dead" project. One might actually subscribe for a paid plan but would receive no support, no updates, nothing, which in my opinion would be disrespectful. Just my 2 cents.

[chronark]

it's not even connected to stripe and never was.
It's just a pretty pricing section, I make $0 from this.