Readme update by JayanithaSivakumar · Pull Request #191 · Fewinfos/github-repo-readme-stats

JayanithaSivakumar · 2026-03-11T04:04:02Z

The README now goes from a basic themes showcase to a comprehensive, professional documentation that properly explains the project, helps users get started quickly, and encourages contributions

Issues fixed#90

-> Introduced `.github/labeler-issues.yml` for keyword-based issue labeling -> Added `.github/workflows/issue-labeler.yml` to automate applying labels -> Helps categorize issues as bug, enhancement, documentation, or testing without manual intervention

…entation - Add professional header with badges and navigation links - Include comprehensive table of contents for easy navigation - Add detailed feature list highlighting all widget capabilities - Expand Quick Start section with multiple usage examples - Document all 4 widget types (Ranking, Analytics, Activity Graph, Streak) - Add customization section with parameter reference table - Include complete deployment guide with step-by-step instructions - Add contributing guidelines and development setup - Include support, acknowledgments, and licensing sections - Improve overall structure and readability - Add clear examples for all features and themes This update transforms the README from a basic theme showcase into comprehensive documentation that helps users understand, deploy, and contribute to the project.

vercel · 2026-03-11T04:04:07Z

@JayanithaSivakumar is attempting to deploy a commit to the shivani-rajalakshmi's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copilot

Pull request overview

This PR updates the repository’s public-facing documentation and adds automation to label GitHub issues based on their content, aiming to improve onboarding and project maintenance.

Changes:

Expanded README.md into a fuller set of docs (features, quick start, customization, deployment, contributing).
Added a GitHub Actions workflow to auto-label issues on open/edit.
Added a label-regex configuration file intended for the issue labeler.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.

File	Description
README.md	Major documentation overhaul with usage examples, deployment steps, and contribution/support sections.
.github/workflows/auto-issues-labeler.yml	New workflow to automatically label issues.
.github/auto-issues-labeler.yml	New regex-based label configuration for the issue labeler.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-11T04:07:51Z


+**Usage:**
+```markdown
+![Ranking](https://github-repo-readme-stats.vercel.app/api/?username=YOUR_USERNAME&repo=YOUR_REPO&type=rank)


The README documents a type query parameter (and separate widget endpoints) (e.g., type=rank on this line), but the deployed API handler (api/index.js) does not read req.query.type and always renders a single combined SVG. Either implement type handling in the API or update this section so the usage examples match the actual behavior.

Suggested change

![Ranking](https://github-repo-readme-stats.vercel.app/api/?username=YOUR_USERNAME&repo=YOUR_REPO&type=rank)

![Ranking](https://github-repo-readme-stats.vercel.app/api/?username=YOUR_USERNAME&repo=YOUR_REPO)

Copilot · 2026-03-11T04:07:51Z

+| `type` | Widget type | `rank` | `rank`, `analytics`, `graph`, `streak` |
+
+### Advanced Customization Examples
+
+#### Combining Parameters
+```markdown
+![Custom Stats](https://github-repo-readme-stats.vercel.app/api/?username=YOUR_USERNAME&repo=YOUR_REPO&theme=tokyonight&type=analytics)
+```


Customization docs list a type parameter (and show examples using type=...), but the API currently doesn’t support type at all. This makes the parameter table and the advanced examples misleading; please remove/correct them or add type support in the API.

Copilot · 2026-03-11T04:07:52Z

+   git clone https://github.com/fewinfos/readme-activity-calender.git
+   cd readme-activity-calender


Deployment instructions clone https://github.com/fewinfos/readme-activity-calender.git and cd readme-activity-calender, which appears to be a different project name than this repo. This will prevent users from deploying this project; update the clone URL and directory name to match the actual repository.

Suggested change

git clone https://github.com/fewinfos/readme-activity-calender.git

cd readme-activity-calender

git clone https://github.com/fewinfos/github-repo-readme-stats.git

cd github-repo-readme-stats

Copilot · 2026-03-11T04:07:52Z

+
+If you encounter any issues or have questions:
+
+- [Open an issue](https://github.com/fewinfos/readme-activity-calender/issues)


Support section links to fewinfos/readme-activity-calender/issues, which is a different repository and will send users to the wrong tracker. Update the issue link to point to this repository’s issues page.

Suggested change

- [Open an issue](https://github.com/fewinfos/readme-activity-calender/issues)

- [Open an issue](https://github.com/fewinfos/github-repo-readme-stats/issues)

Copilot · 2026-03-11T04:07:52Z

+        uses: github/issue-labeler@v3
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          configuration-path: .github/labeler-issues.yml


configuration-path points to .github/labeler-issues.yml, but this PR adds .github/auto-issues-labeler.yml instead. As-is, the workflow will fail to find its config; either rename the config file to .github/labeler-issues.yml or update configuration-path to the added file.

Suggested change

configuration-path: .github/labeler-issues.yml

configuration-path: .github/auto-issues-labeler.yml

Copilot · 2026-03-11T04:07:52Z

+bug:
+  - '(?i)bug'
+


This labeler config file name doesn’t match the workflow’s configuration-path (.github/labeler-issues.yml). Unless the workflow is updated, this file will be unused and issue labeling won’t work; align the filename/path with the workflow configuration.

Copilot · 2026-03-11T04:07:53Z

+[![License](https://img.shields.io/github/license/fewinfos/readme-activity-calender)](LICENSE)
+[![Issues](https://img.shields.io/github/issues/fewinfos/readme-activity-calender)](https://github.com/fewinfos/readme-activity-calender/issues)
+[![Stars](https://img.shields.io/github/stars/fewinfos/readme-activity-calender)](https://github.com/fewinfos/readme-activity-calender/stargazers)


The badges/links at the top reference fewinfos/readme-activity-calender, which doesn’t match this repository (github-repo-readme-stats). This will show the wrong license/issues/stars and send users to the wrong issue tracker/stargazers page; update these badge URLs/targets to the correct repo.

Suggested change

[![License](https://img.shields.io/github/license/fewinfos/readme-activity-calender)](LICENSE)

[![Issues](https://img.shields.io/github/issues/fewinfos/readme-activity-calender)](https://github.com/fewinfos/readme-activity-calender/issues)

[![Stars](https://img.shields.io/github/stars/fewinfos/readme-activity-calender)](https://github.com/fewinfos/readme-activity-calender/stargazers)

[![License](https://img.shields.io/github/license/fewinfos/github-repo-readme-stats)](LICENSE)

[![Issues](https://img.shields.io/github/issues/fewinfos/github-repo-readme-stats)](https://github.com/fewinfos/github-repo-readme-stats/issues)

[![Stars](https://img.shields.io/github/stars/fewinfos/github-repo-readme-stats)](https://github.com/fewinfos/github-repo-readme-stats/stargazers)

JayanithaSivakumar added 4 commits August 17, 2025 07:56

feature: auto-issues-labeler Fewinfos#90

1d2d5d4

Issues fixed#90

Merge branch 'Fewinfos:main' into main

386d499

Copilot AI review requested due to automatic review settings March 11, 2026 04:04

github-actions Bot added docs related to documents workflows labels Mar 11, 2026

Copilot started reviewing on behalf of JayanithaSivakumar March 11, 2026 04:04 View session

Copilot AI reviewed Mar 11, 2026

View reviewed changes

Navigation Menu

Uh oh!

Uh oh!

Readme update - #191

Readme update#191
JayanithaSivakumar wants to merge 4 commits into
Fewinfos:mainfrom
JayanithaSivakumar:docs/comprehensive-readme-update

JayanithaSivakumar commented Mar 11, 2026

Uh oh!

vercel Bot commented Mar 11, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

Copilot AI Mar 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	![Ranking](https://github-repo-readme-stats.vercel.app/api/?username=YOUR_USERNAME&repo=YOUR_REPO&type=rank)
	![Ranking](https://github-repo-readme-stats.vercel.app/api/?username=YOUR_USERNAME&repo=YOUR_REPO)

		git clone https://github.com/fewinfos/readme-activity-calender.git
		cd readme-activity-calender


		If you encounter any issues or have questions:

		- [Open an issue](https://github.com/fewinfos/readme-activity-calender/issues)

	configuration-path: .github/labeler-issues.yml
	configuration-path: .github/auto-issues-labeler.yml

		bug:
		- '(?i)bug'

Uh oh!

Uh oh!

Conversation

JayanithaSivakumar commented Mar 11, 2026

Uh oh!

vercel Bot commented Mar 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants