Ship a proper documentation with Tailviewer

Kittyfisto / Tailviewer

Open source log file viewer

https://kittyfisto.github.io/Tailviewer/

MIT License

200 stars 37 forks source link

Ship a proper documentation with Tailviewer #257

Open Kittyfisto opened 3 years ago

Kittyfisto commented 3 years ago

Every tailviewer should ship with a proper user documentation.
The documentation should be maintained manually and be written in english.
The latest version of the documentation shall also be accessible via https://kittyfisto.github.io/Tailviewer/.

Kittyfisto commented 3 years ago

At the moment, I'm thinking delivering the documentation as a bunch of static html pages which can be viewed locally by a browser of the user's choice. The same pages could then be uploaded to github.io providing the same documentation online as well.