musicblocks icon indicating copy to clipboard operation
musicblocks copied to clipboard

[Docs] Adding all documentation files in Docs/

Open AnudeepReddyBondugula opened this issue 2 years ago • 7 comments

Current State

Currently there are different folders of documentation for each language (like: document-es, document-ja etc) in the root folder

Desired State

It would be nice to have the documentation folders of all languages in a single folder called Docs/ making better code readability and maintainability

AnudeepReddyBondugula avatar Jan 10 '24 17:01 AnudeepReddyBondugula

@walterbender can I work on this documentation issue?

arush-webd avatar Jan 10 '24 17:01 arush-webd

Why is this an improvement?

walterbender avatar Jan 10 '24 22:01 walterbender

Why is this an improvement?

Assume in future there will be documentations on multiple languages. The root folder of the project becomes so long(es, ja,..... list goes on). So I thought it would be a better idea to add a seperate Docs folder where we can find every thing related to documention.

AnudeepReddyBondugula avatar Jan 11 '24 03:01 AnudeepReddyBondugula

hey @AnudeepReddyBondugula I think organizing the documents in different files makes it easier to read, maintain and work with. It's a kind of sorting so that we get things easily from the docs. I'll appreciate any feedback or correction. thanks.

apsinghdev avatar Jan 11 '24 08:01 apsinghdev

I'm sold...

walterbender avatar Jan 11 '24 17:01 walterbender

I'm not sure it'll be much of an improvement as of now. But if @walterbender thinks it is I can also take a similar approach for guide.

mohitvdx avatar Jan 11 '24 22:01 mohitvdx

Sure...

walterbender avatar Jan 12 '24 15:01 walterbender

@sum2it good first issue

Ubayed-Bin-Sufian avatar Mar 18 '25 08:03 Ubayed-Bin-Sufian

Just be sure to update all of the image links in the .md and .html files. And we prob. need to update the help widget as well.

walterbender avatar Mar 20 '25 23:03 walterbender

Hi, @AnudeepReddyBondugula I’m interested in working on this issue as my first contribution. From what I understand, the task is to move all the existing language specific documentation folders (document-es, document-ja, etc.) into a single parent folder named Docs/ for better readability and maintainability. Please let me know if I can take this up, and if there are any specific guidelines I should follow while restructuring.

abhishiv17 avatar Aug 25 '25 09:08 abhishiv17

To whomever works on this, it is important that the help widget know about where the new artwork is moved to.

walterbender avatar Aug 25 '25 11:08 walterbender