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

[DOCS]: Formatting Readme to emphasize main points #3

Open
ace-builds opened this issue Jul 16, 2023 · 0 comments
Open

[DOCS]: Formatting Readme to emphasize main points #3

ace-builds opened this issue Jul 16, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ace-builds
Copy link
Owner

ace-builds commented Jul 16, 2023

Description

Overview of the Project

Power Code AI is a VS Code extension designed to enhance developers' coding experience by providing an AI-powered personal assistant. By simply typing your intentions to the editor, it generates the code so you can focus on focus on more complex logic, code faster and more efficiently.

You can watch the demo here

Example

For instance, by using the command "Write a function that sums two numbers," the extension generates a function in the programming language you're using that adds two numbers.

The Problem

The current state of the ReadMe file lacks important details that potential users & contributors should know. Here are the areas that require improvement:

  • Emphasis: The ReadMe does not adequately emphasize essential points, such as the requirement of an Open AI key to use the VS Code extension.
  • Project Badges: There is a lack of badges to display the current statistics or status of the repository.

Suggestions

We welcome your valuable input and ideas on how to enhance this ReadMe to provide clearer guidance and information for potential contributors.

We would greatly appreciate any suggestions or improvements you have in mind to make this ReadMe more informative and accessible to those interested in contributing to the project. Feel free to share your ideas and let's collaborate to improve the documentation together.

Possible solution

Highlights

Here are some sections that would need to be highlighted better

  • Open AI required section
  • How to prompt command for the current features; "Power your code" & "Explain code" (Not available yet)

You're free to be as creative as you can.

Badges

Below is a screenshot of the Pretty TypeScript Errors extension ReadMe where they highlighted the project badge.

You can model after it in create the badges for this repo
image

Alternatives

No response

Additional information

We appreciate your interest in contributing to this extension and looking forward to how you can make us better

@ace-builds ace-builds added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant