Skip to content

Conversation

@a2937
Copy link
Member

@a2937 a2937 commented Jan 15, 2025

Checklist:

Closes #539 and Closes #540

I've added documentation for all of our methods that was named on the issues. Additionally I added all of the AST Helper methods onto the curriculum helper page.

@a2937 a2937 requested a review from a team as a code owner January 15, 2025 17:20
@raisedadead raisedadead changed the title chore: add helper documentation docs: add helper documentation Jan 15, 2025
@gikf
Copy link
Member

gikf commented Jan 17, 2025

Is this supposed to completely replace the documentation from curriculum-helpers - https://opensource.freecodecamp.org/curriculum-helpers/ / https://github.com/freeCodeCamp/curriculum-helpers/tree/main/docs? Keeping the two copies updated is not going to be very convenient.

@ilenia-magoni
Copy link
Contributor

@gikf the final goal is to have /contribute replace all the small repo docs we have around, it makes sense that also curriculum-helpers docs is folded here

@gikf
Copy link
Member

gikf commented Jan 30, 2025

@gikf the final goal is to have /contribute replace all the small repo docs we have around, it makes sense that also curriculum-helpers docs is folded here

Last complain then 😛. Specifically for Python, the https://contribute.freecodecamp.org/curriculum-help/#ast-based-helpers is a general overview how to use the ast_helpers, while the https://opensource.freecodecamp.org/curriculum-helpers/python.html is more a reference of all methods. Both have their place in documentation, but joining them together, on the same page, can make using it for these two separate reasons, a bit harder.

@ilenia-magoni
Copy link
Contributor

@gikf the documentation can be organized to have two sections then, one with the general overview, and the other with the list of all methods, both in this repo

@raisedadead raisedadead merged commit bdb1a28 into freeCodeCamp:main Feb 14, 2025
4 checks passed
@a2937 a2937 deleted the chore/add-helper-documentation branch February 14, 2025 15:18
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.

All Curriculum Helpers need documentation All CSSHelp methods need documentation

6 participants