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

Move the docs from Github's wiki to the ./docs directory #1008

Closed
LubomirGeorgiev opened this issue Jun 14, 2022 · 10 comments · Fixed by #1236, #1239, #1248, #1283 or #1284
Closed

Move the docs from Github's wiki to the ./docs directory #1008

LubomirGeorgiev opened this issue Jun 14, 2022 · 10 comments · Fixed by #1236, #1239, #1248, #1283 or #1284
Labels
help wanted Please someone help on this

Comments

@LubomirGeorgiev
Copy link

LubomirGeorgiev commented Jun 14, 2022

It will be way easier for people to search something in the docs if they are part of the repo itself instead of relying on GitHub to host the docs.

@dai-shi
Copy link
Member

dai-shi commented Jun 14, 2022

Yeah, that's my plan too. We have ./docs folder just recently.
Would you like to help the migration? I think it's good time for us to review the contents thoroughly. Maybe, we should try moving one by one. (one PR per one page).

@dai-shi dai-shi added the help wanted Please someone help on this label Jun 14, 2022
@chann44
Copy link
Contributor

chann44 commented Jun 16, 2022

can i help in this

@dai-shi
Copy link
Member

dai-shi commented Jun 16, 2022

sure!

@chann44
Copy link
Contributor

chann44 commented Jun 16, 2022

so i have read about wiki i think i'll need access to wiki am i right
also do i have to manually write these files from wiki to ./docs or we can just change the file path or something

@dai-shi
Copy link
Member

dai-shi commented Jun 16, 2022

you have read access to wiki. at least you can edit it.
so, steps are:

  1. pick one wiki page
  2. copy content to ./docs/*.md
  3. create a PR
  4. improve the content through review
  5. then merge
  6. loop back to 1.

@chann44
Copy link
Contributor

chann44 commented Jun 16, 2022

i got it

@chann44
Copy link
Contributor

chann44 commented Jun 16, 2022

can you assign this to me now

@chann44
Copy link
Contributor

chann44 commented Jun 16, 2022

it should be markdown file right

@chann44
Copy link
Contributor

chann44 commented Jun 16, 2022

i created a pr now see f it's right the format

@dai-shi
Copy link
Member

dai-shi commented Jul 5, 2022

@Carnageous is in.

@chann44 Are you still around? If you guys need coordination, please use this issue for discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Please someone help on this
Projects
None yet
3 participants