Enhance README.md Documentation: Improved Project Description, Installation Instructions, Troubleshooting, and Contributing Guidelines

ricardocarva commented 9 months ago

Pull Request Description

This pull request aims to enhance the documentation for the Betaflight.com project by addressing identified gaps and improving clarity and usability. It includes a variety of enhancements, such as providing a concise project description, detailed installation instructions, troubleshooting guidance, contributing guidelines, and more. These changes aim to make the documentation more comprehensive and user-friendly, enabling users to better understand the Betaflight.com project and effectively contribute to it.

Documentation Enhancements:

Image And Discord Badge: Included the Betaflight logo and the Discord badge.
Project Description: Added a clear overview of the website's purpose and target audience.
Table of Contents: Included for better organization and navigation.
Installation and Setup: Expanded with detailed steps for different operating systems and troubleshooting guidance.
Usage Instructions: Provided examples to help users navigate the site's features, and understand what is in there.
Contributing Guidelines: Referenced CONTRIBUTING.md.

These changes address identified gaps in the documentation, making it more informative, user-friendly, and conducive to collaboration and contribution.

netlify[bot] commented 9 months ago

Deploy Preview for origin-betaflight-com ready!

Name	Link
Latest commit	a318a828589bce4949430898f7da35fc5f5ffeb3
Latest deploy log	https://app.netlify.com/sites/origin-betaflight-com/deploys/65cc036e90bc600008177f3f
Deploy Preview	https://deploy-preview-376--origin-betaflight-com.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sonarcloud[bot] commented 9 months ago

Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

ricardocarva commented 9 months ago

My apologies, @SupaflyFPV and @haslinghuis. I found a typo in my previous commit, so I had to update it and push it again. Kindly view the PR again.

SupaflyFPV commented 9 months ago

My apologies, @SupaflyFPV and @haslinghuis. I found a typo in my previous commit, so I had to update it and push it again. Kindly view the PR again.

no worries - thanks for contributing 👍

betaflight / betaflight.com