Migration of documents from wiki to the docs directory of the repository

[ajiho]

Clear and concise description of the problem

I have checked the documentation related to this project and found the following two places

• https://github.com/6pac/SlickGrid/wiki
• https://slickgrid.net/

Although the wiki is excellent, others cannot modify it. The documentation should also be a part of contributing code, and those who want to contribute may translate the documentation into a language they are familiar with

As for the website slickgrid.net Opening it caused me to lose half of my interest in reading . It's really ugly, forgive me for being too direct . I have seen the repository and will migrate towards modernization, such as moving away from jQuery and adopting typescript behaviors Therefore, the document section should also be rewritten using some modern document tools .Finally, we only need to maintain it in one place, not in a wiki or slickgrid .If you agree to do so, perhaps I can help

Suggested solution

I am familiar with Vitepress and have helped many projects rewrite documents and migrate to Vitepress

The effect can be viewed vitepress

Alternative

No response

Additional context

No response

Validations

• Follow our Code of Conduct
• Read the Wikis.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

[ghiscoding]

Sure go ahead, it's an open source maintained in our spare time and documentations is not where we typically spend our time (we always considered that all the Examples are the docs). Side note however, I've never used Vitepress and where would these docs be stored? Can that be uploaded to the GitHub Pages of the project? I don't have access to that part though, @6pac would have to update that part

[ajiho]

Yes, everyone has their own work and life, The purpose of Vitepress is to reduce the time required for document maintenance, as you only need to maintain the markdown file. The markdown file can be stored in the docs directory of the repository. Yes, it can be deployed on GitHub Pages

[6pac]

@ajiho I'm just not sure on the advantqge of using a tool versus just having the docs in the GitHub wiki and perhaps making them editable (I actually thought they were - I think we can make them so).

Re the comments on slickgrid.net - yes you are right, it is ugly. I designed it, and I'm very much a backend guy. I've tried to make it look better several times but not succeeded. I think the best would be to merge it into the wiki and then forward from the domain.

The main reason we registered it was because the old original (now inactive) SlickGrid repo consistently appeared in search results above the live repo. I thought a domain was the best way of trying to escalate search ranking for the correct site. This is probably no longer an issue - we could post a single page notice to go to the repo, or page redirect, or perhaps just leave it to expire and remove the site altogether.

[ajiho]

Yes, we can edit wikis, but only warehouse maintainers have the authority to update them . In open source, contributions should also work for documentation. Once the documentation is there, contributions to this documentation would follow the usual Pull Request pattern. Regarding slickgrid.net, once we use a tool to build documents, we can deploy it using GitHub pages or Vercel, and then bind the domain name. Perhaps a good project should have its own domain name, haha

[ajiho]

As I mentioned earlier, doing so can also better support internationalization

[6pac]

@ajiho if you are happy to set something up, I'm happy to try it out. What we really need as well is to work on the content.

Just FYI my favourite documentation of all time is moment js - they use a cool little javascript lib to sync the content and detail points.

[ghiscoding]

@ajiho are you still interested in doing this docs migration? I would say that we are both certainly welcome to the idea, so any PR for this change would be welcomed. Thanks