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

docs: add helper documentation #544

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

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
}
```

You would get an object that looks like this:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

with what code?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this help?

@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

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
3 participants