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

Add guide to README on how to run the documentation website #15

Closed
HassanBahati opened this issue Jan 6, 2023 · 4 comments · Fixed by #49
Closed

Add guide to README on how to run the documentation website #15

HassanBahati opened this issue Jan 6, 2023 · 4 comments · Fixed by #49
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@HassanBahati
Copy link
Collaborator

HassanBahati commented Jan 6, 2023

you may use the guidelines below, in README.md ,create a subheading Build Documentation Website then add these below;

the website directory is where we have the documentation that is built on top of docusaurus v2 which uses concepts of react.js so anyone that has done react can just work with it.

to run the website which also is where are going to be writing documentation....

  1. move into the website directory cd website
  2. install packages using pnpm install
  3. start the development server pnpm run start which will open your browser at http:localhost:3000

pnpm is a package manger just like npm or yarn

@HassanBahati HassanBahati added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jan 6, 2023
@Rishav1707
Copy link
Contributor

you may use the guidelines below, in README.md ,create a subheading Build Documentation Website then add these below;

the website directory is where we have the documentation that is built on top of docusaurus v2 which uses concepts of react.js so anyone that has done react can just work with it.

to run the website which also is where are going to be writing documentation....

  1. move into the website directory cd website
  2. install packages using pnpm install
  3. start the development server pnpm run start which will open your browser at http:localhost:3000

pnpm is a package manger just like npm or yarn

Shall I work on this issue?

@HassanBahati
Copy link
Collaborator Author

you may use the guidelines below, in README.md ,create a subheading Build Documentation Website then add these below;
the website directory is where we have the documentation that is built on top of docusaurus v2 which uses concepts of react.js so anyone that has done react can just work with it.
to run the website which also is where are going to be writing documentation....

  1. move into the website directory cd website
  2. install packages using pnpm install
  3. start the development server pnpm run start which will open your browser at http:localhost:3000

pnpm is a package manger just like npm or yarn

Shall I work on this issue?

Hi @Rishav1707 yes you can please go ahead

@HassanBahati
Copy link
Collaborator Author

The documentation is built with docusaurus. Please find the guide in the docusaurus documentation here https://docusaurus.io/docs/installation#running-the-development-server

@HassanBahati
Copy link
Collaborator Author

Please in the readme for the reactui-documentations include the start commands and also what tools we are using to build the documentation

This was referenced Jan 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants