Mentorship-backend: Move docs from wiki to Docusaurus

Created on 24 Aug 2020  路  19Comments  路  Source: anitab-org/mentorship-backend

Is your feature request related to a problem? Please describe.
As of now, the whole documentation for mentorship-backend is in the wiki.

Describe the solution you'd like
We will now move to Docusaurus.

Describe alternatives you've considered
Docusaurus

Additional context
TODO:

  • [ ] Add a basic minimal scaffold in docs/ (use Tinysaurus)
  • [ ] Remove the old files from docs/

DocumentatioTraining

Most helpful comment

We need to break each of the list items in separate issues for OSH, because this in itself is a pretty big issue.

All 19 comments

We need to break each of the list items in separate issues for OSH, because this in itself is a pretty big issue.

can I work on this in the open source hack

yes @vaibhavarora102 do u want to work on it?

Yes for sure

Hi @vaibhavarora102, the issues meant for open source hack will be assigned / can be claimed only when the program starts on September 1st, 2020 on a first come first serve basis. Do come back and comment here on 1st and will assign you.

Can I take this at night 12 :00 of 31st

Hi @gaurivn , can you pls assign this issue to me as its already 1st of September and I guess OSH has started
Thanks

Hi @gaurivn , can you pls assign this issue to me as its already 1st of September and I guess OSH has started
Thanks

Sure, assigned

I would like to work on this issue under OSH. Please assign me this issue when it's free.

I wolud like to work on this .Can you assign this to me when it's free??Thank You

@vaibhavarora102 how's the PR going?

hi i am not getting the way to deal with docusaurus

Would you like to be unassigned from the issue?

yes pls

I can do this work. So please assign me this work @SanketDG @gaurivn

Assigning you @codesankalp
Happy documenting!

@vj-codes @PrashanthPuneriya
should i remove all the old files from docs ?
I have solved this issue by using tinysauraus.

@codesankalp I think we shouldn't remove anything from docs/...
We don't have access to remove wiki and the wiki has many docs linking to docs/.. folder files. It is better if we remove the docs/.. only if we remove wiki. So, let it be @codesankalp

@PrashanthPuneriya Please review my pull request. Thanks.

Was this page helpful?
0 / 5 - 0 ratings