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

Create documentation based on markdown #7624

Closed
Siemienik opened this issue Mar 11, 2021 · 0 comments · Fixed by #7626
Closed

Create documentation based on markdown #7624

Siemienik opened this issue Mar 11, 2021 · 0 comments · Fixed by #7626
Assignees

Comments

@Siemienik
Copy link
Contributor

Siemienik commented Mar 11, 2021

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:

  • Move our documentation to this repository, which will help manage it during the development process.
  • Convert all documents from the current HTML format to Markdown. That makes it much more manageable and technology independent.
  • Improve the graphical layout of our documentation, which makes using it much more convenient.
  • Change search engine to a new one with a much better experience.
  • Automate the deployment process by using GH Action,
  • Ensure that will works with previous documentation versions.
  • The new documentation should be placed in this repository in /docs/ directory.
@Siemienik Siemienik self-assigned this Mar 11, 2021
@Siemienik Siemienik linked a pull request Jul 6, 2021 that will close this issue
6 tasks
@Siemienik Siemienik mentioned this issue Jul 8, 2021
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants