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

Use Generative AI tools to add and improve developer documentation for freeCodeCamp Classroom #391

Closed
lloydchang opened this issue Jul 24, 2023 · 4 comments

Comments

@lloydchang
Copy link
Contributor

lloydchang commented Jul 24, 2023

Describe the issue
Use Generative AI tools to add and improve developer documentation for freeCodeCamp Classroom.

To Reproduce
Steps to reproduce the behavior:

  1. Mintlify Writer https://writer.mintlify.com/
  2. Sourcegraph Code Search https://about.sourcegraph.com/code-search
  3. Sourcegraph Cody https://docs.sourcegraph.com/cody
  4. Genie, OpenAI ChatGPT, Visual Studio Code https://github.com/ai-genie/chatgpt-vscode
  5. Additional Code Assistant Tools https://github.com/sourcegraph/awesome-code-ai

Expected behavior
Add and improve developer documentation for freeCodeCamp Classroom

Additional context
@theGaryLarson and I had a conversation via CodeDay Labs Slack:

  • I suggested the above, and @theGaryLarson found the Generative AI tools such as Mintify Writer useful in helping @theGaryLarson, a developer, understand the codebase better.

Tasks

Preview Give feedback
No tasks being tracked yet.
@theGaryLarson
Copy link
Contributor

I would like this assigned. I am currently working on issue #166 but am going to document the code base with mintlify and read through it to better understand the codebase.

@theGaryLarson
Copy link
Contributor

Closed that draft PR and restarting fresh with the recent refactors to processing dashboard data.

@lloydchang
Copy link
Contributor Author

Please contact @GuillermoFloresV if you have further questions about this. Thanks!

@lloydchang
Copy link
Contributor Author

lloydchang commented Aug 3, 2023

Closing this because it's no longer needed based on #417 (comment)

While I agree with the spirit of the PR I do not believe that commenting to the extent the PR does is entirely necessary. There are other (IMO, better) ways to improve a new contributor's contribution experience. That being said, if writing lots of comments to explain our logic is truly needed, we can write about them either in a blog post or enable the wiki for the project inside of GitHub where we can write about this type of stuff without cluttering files with tons of comments.

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

No branches or pull requests

2 participants