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
Create documentation based on markdown #7624
Labels
Comments
This was referenced Apr 20, 2021
This was referenced May 6, 2021
5 tasks
11 tasks
5 tasks
wszymanski
added a commit
that referenced
this issue
Jun 10, 2021
wszymanski
added a commit
that referenced
this issue
Jun 10, 2021
This was referenced Jun 22, 2021
17 tasks
6 tasks
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Documentation
For each project, the documentation is a significant place where the customers derive knowledge about how to use that tool. That explains why it is worth to care about the experience of using the documentation. For this purpose, this issue was created.
Current
Our current documentation has a repository: https://github.com/handsontable/docs, and it is hosted on https://handsontable.com/docs/. The content is kept in HTML format. The current search is searching only over sidebar labels.
That makes that using and searching the documentation is difficult.
After
We gain nicer looking documentation with a better search engine. Using markdown makes easier documentation maintenance for non-technical personnel. After this issue being resolved, versioning and automated deployment will be simpler.
Creating and testing documentation becomes less time-consuming, and for our clients, we remove difficulties in using and searching the documentation.
Assumptions:
/docs/
directory.The text was updated successfully, but these errors were encountered: