freeCodeCamp / classroom

BSD 3-Clause "New" or "Revised" License
143 stars 120 forks source link

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

Closed lloydchang closed 1 year ago

lloydchang commented 1 year ago

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:

theGaryLarson commented 1 year ago

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 commented 1 year ago

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

lloydchang commented 1 year ago

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

lloydchang commented 1 year ago

Closing this because it's no longer needed based on https://github.com/freeCodeCamp/classroom/pull/417#issuecomment-1664756417

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.