Skip to content

Conversation

@iamsparkedev
Copy link
Member

@iamsparkedev iamsparkedev commented Sep 29, 2025

Pull Request

📝 Description

  • Worked on api/doc/

Related Issues

Closes #16

🚀 Type of Change

  • 📚 Documentation update

@iamsparkedev iamsparkedev added the documentation Improvements or additions to documentation label Sep 29, 2025
Copy link
Contributor

@aditsuru aditsuru left a comment

Choose a reason for hiding this comment

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

Several changes are needed.

The main problem is the writing style. It uses too many references and too much formatting, and it doesn’t clearly explain how to actually add the feature to our app. Right now, it focuses on the GitHub API itself, not on how it fits into our app.

Other small issues:

  • It talks about a point system but doesn’t explain what it is or why it matters for our project.
  • There are too many “[1]” references.

Suggestions:

  • Write it clearly in your own words, like a guide for other developers.
  • Focus on our project. Explain not just the endpoints, but how we will use them. For example, if some endpoints are not needed, say: “We will use a simple Python library that handles the requests for us.”

You can check this link to see an example of the writing style we want.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC 1] GitHub Issue Creation Flow

3 participants