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.

Sign up for GitHub

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

Jump to bottom

[FEATURE] Separate out ReadMe and Examples for each package #103

Open
kashifkhan0771 opened this issue Jan 28, 2025 · 1 comment
Open

[FEATURE] Separate out ReadMe and Examples for each package #103

kashifkhan0771 opened this issue Jan 28, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers question Further information is requested

Comments

@kashifkhan0771
Copy link
Owner

Feature Description

The README.md and EXAMPLES.md is file is increasing day by day. I have a suggestion to separate README.md and EXAMPLES.md for each package and link them in main README.md.

Use Case

Clean structure and avoid conflicts if multiple people are contributing

Proposed Solution

Each package with separate README.md and EXAMPLES.md and their link is added in main README.md for reference.

Additional Context

N/A

Pseudo Code

N/A
@kashifkhan0771 kashifkhan0771 added documentation Improvements or additions to documentation good first issue Good for newcomers question Further information is requested labels Jan 28, 2025
@kashifkhan0771
Copy link
Owner Author

This is my suggestion to the problem - if you have any other suggestion feel free to discuss in this issue before the implementation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers question Further information is requested
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kashifkhan0771