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

Documented existing codebase and modules in [octoffers/platforms] #2

Open
wants to merge 20 commits into
base: master
Choose a base branch
from

Conversation

danieltayal07
Copy link

added a few pointers in _index.md
created djinni.md and added documentation about it
added pointers in drivers.md
created profile.md and added documentation about it

If the contributions are found useful, i would love to see it merged!
Thank You for the opportunity!! ❤️

@webgtx
Copy link
Contributor

webgtx commented Oct 20, 2024

Hey @danieltayal07, first of all thank you for your effort.
Don't take it personally, but did you use an AI chatbot to generate most of this content? :shipit:

@webgtx
Copy link
Contributor

webgtx commented Oct 20, 2024

I don't mind utilizing AI, but the problem is that the content is rather bloated.

@danieltayal07
Copy link
Author

danieltayal07 commented Oct 20, 2024

I used chatgpt to add the extra information

First i sent all the code to chatgpt and asked to explain me what does each and every line do, after that i wrote a summary for each in my words and then i asked it to improve it and increase it.

I knew it is very repetitive and long
I can shorten it without AI cause i khow what Octoffers do now.

If possible i will do that by the end of the day and commit the changes.

Thank you for understanding sir and apologies

@danieltayal07
Copy link
Author

Hii @webgtx sir hope you are good

this time i have tried not to use AI for help rather i tried removing the bloated content myself from the files,
please have a look at it when available and give feedback.

Thank You 🫶

@webgtx
Copy link
Contributor

webgtx commented Oct 21, 2024

@danieltayal07, most of the text still generated.
Regarding documentation for djinni driver: You don't have to explain line by line code of the each method. You have to understand the codebase, and give the instructions for the user on how to use it rather then stating that you're importing os libraries for OS operations.

I tried to set you an example here, try to do the same for the apply method.

You can also look into this documentation for an example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants