-
-
Notifications
You must be signed in to change notification settings - Fork 81
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: Create documentations for the available commands #102
Comments
Btw... If anyone know this, then please do tell me: How do you serve the production build? (Created the prod build with |
serve -c serve.json
|
Hey, how do I contribute to the docs? I want to work on this issue |
hi, can I work on this? |
TBH, I think the bulk of these are commands that contributors will rarely, if ever, run. I'd rather focus on keeping the documentation up to date in the step-by-step guide format it already is. |
I agree that most people wouldn't need them but still it's best to have them documented IMO. But I do admit keeping the docs up-to-date is going to be a challenge.
But there's one thing that needs some clarification IMO. The page in the docs explaining how to run the Cypress tests needs some more explanations because some of the tests fail to run because Mailhog wasn't configured properly. Maybe a small reminder saying that they should set up Maihog before running the Cypress tests otherwise expect the tests for the emails to fail. |
I would like to work on this issue is it still available? |
Currently we have a lot of available commands in the project but most, if not all, contributors have little to no idea what they do. In light of the issue freeCodeCamp/freeCodeCamp#50991, I think it's important we create some sort of documentations for these commands. That way contributors can know what these commands do and we can prevent issues like freeCodeCamp/freeCodeCamp#50991.
The text was updated successfully, but these errors were encountered: