Appendix for the organization's 'readme'

[Abhijay007]

This discussion is meant to capture issues, questions, and requirements related to the implementation of the Appendix for the organization's 'readme' on the .github folder :)

To give you all a short overview that what this Appendix is for and how we can use .github folder, I write a short note here 👇

Currently, keploy org repo does not have the special readme in the "overview section" to display the required info about keploy and different projects/repo we have under the org, Adding an Appendix and glossary section will help new visitors to learn more about the project in a short amount of time.

To know about the .github you can follow this blog

I request all the contributors to drop their suggestions and thoughts on it under this discussion :)

[nehagup]

Sounds good addition to me Abhijay!

This will enhance the representability of Keploy Github org! Thanks for taking this up!👍

Would love to know what all can we add in.

• Must have
• Good to have

[Sarthak160]

Surely, It will be a good implementation and will really help new comers to know different repos and aspects of Keploy org in a quick and better way

Looking forward for it 🚀

[slayerjain]

@Abhijay007 Thanks for posting this.

I think this can help implement uniform policies for all our repos. Since we'll have SDKs in different languages and also examples.

LGTM! 😄

[unnati914]

maybe we can include contributing.md too

[Ayush7614]

@Abhijay007 @nehagup @Sarthak160 @unnati914 Hlo All Can i start working on this and @Abhijay007 it is very good idea

[nehagup]

Yes, definitely! Would love to see this in action.⭐

[Ayush7614]

Yes, definitely! Would love to see this in action.⭐

so @nehagup please make a repository of name .github or you can give me access i can make

[nehagup]

Ref - keploy/.github#1

[shub-garg]

Adding an Appendix and glossary section to the .github folder sounds like a great idea. It will provide new visitors with a quick overview of Keploy and various projects, making it easier to understand and get involved.

Looking forward to your ideas!

[Sonichigo]

We are working on creating a GitHub Wiki for the first time contributor/visitor to understand and get involved with keploy easily.

I think it would be good to add their references to the org readme for better visibility.
ref:- keploy wiki

[shub-garg]

Yep!