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

chore(docs): add documentation #105

Merged
merged 2 commits into from
Dec 11, 2023
Merged

chore(docs): add documentation #105

merged 2 commits into from
Dec 11, 2023

Conversation

ShaunSHamilton
Copy link
Member

This adds boilerplate documentation which is deployed at https://opensource.freecodecamp.org/curriculum-helpers/

I will open issues for some other things relating to the docs.

@ShaunSHamilton ShaunSHamilton requested a review from a team as a code owner December 9, 2023 13:10
@naomi-lgbt
Copy link
Member

Two thoughts:

  • The docs framework used seems like massive overkill (that's a lot of files for documentation)
  • Wouldn't we prefer these in the main docs anyway?

@ShaunSHamilton
Copy link
Member Author

Two thoughts:

  • The docs framework used seems like massive overkill (that's a lot of files for documentation)
  • Wouldn't we prefer these in the main docs anyway?

Same answer for both: These are going to be quite extensive docs - lots to say/share.

If we put these in the main docs, I will forget to update them, and, if we want the same features, it will take extensive rewrite of the main docs.

@naomi-lgbt naomi-lgbt self-requested a review December 10, 2023 01:59
@naomi-lgbt
Copy link
Member

Gonna pull this down and give it a peek tomorrow :3

Copy link
Member

@naomi-lgbt naomi-lgbt left a comment

Choose a reason for hiding this comment

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

It builds locally and looks like a site.

@naomi-lgbt naomi-lgbt merged commit 0d7e0a2 into main Dec 11, 2023
3 checks passed
@naomi-lgbt naomi-lgbt deleted the feat_documentation branch December 11, 2023 16:27
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