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: Create documentations for the available commands #102

Open
Twaha-Rahman opened this issue Jul 17, 2023 · 7 comments · May be fixed by #149
Open

docs: Create documentations for the available commands #102

Twaha-Rahman opened this issue Jul 17, 2023 · 7 comments · May be fixed by #149
Labels
type: feature request Threads classified to be feature requests. Implementation to be considered as a nice to have

Comments

@Twaha-Rahman
Copy link

Twaha-Rahman commented Jul 17, 2023

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.

Screenshot from 2023-07-17 12-21-03
Screenshot from 2023-07-17 12-21-41

@Twaha-Rahman
Copy link
Author

Btw... If anyone know this, then please do tell me: How do you serve the production build?

(Created the prod build with pnpm run build)

@ShaunSHamilton
Copy link
Member

How do you serve the production build?

serve -c serve.json

https://contribute.freecodecamp.org/#/devops?id=first-install-2

@gikf gikf added the type: feature request Threads classified to be feature requests. Implementation to be considered as a nice to have label Jul 17, 2023
@aqsaaqeel
Copy link

Hey, how do I contribute to the docs? I want to work on this issue

@hafeeluddeen
Copy link

hi, can I work on this?

@naomi-lgbt
Copy link
Member

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.

@Twaha-Rahman
Copy link
Author

Twaha-Rahman commented Oct 15, 2023

TBH, I think the bulk of these are commands that contributors will rarely, if ever, run.

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.

I'd rather focus on keeping the documentation up to date in the step-by-step guide format it already is.

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.

@ARMummert
Copy link

I would like to work on this issue is it still available?

@naomi-lgbt naomi-lgbt transferred this issue from freeCodeCamp/freeCodeCamp Apr 26, 2024
@a2937 a2937 linked a pull request May 29, 2024 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature request Threads classified to be feature requests. Implementation to be considered as a nice to have
Projects
Status: Backlog
8 participants
@Twaha-Rahman @ShaunSHamilton @gikf @naomi-lgbt @hafeeluddeen @aqsaaqeel @ARMummert and others