kanji-koohii
kanji-koohii copied to clipboard
Improve the documentation / Help page
The documentation (aka "Help" in mobile nav) is completely outdated (has been for years, sigh).
URL in question : http://staging.koohii.com/learnmore
Copy editing
- [ ] Needs summarizing
- [ ] Rewording to avoid mentioning "clicks" or "mouse" unless really necessary (to keep things simple because I don't want to handle 2 documentation pages!)
Structure
- [ ] Find some way to break it down (maybe a Vue JS component here that would collect sections then display them one at a time via expand-collapse)
Pictures
- [x] Needs up to date pictures, potentially higher DPI too
Navigation
- [x] Use fixed to top navigation on desktop (sidebar doesn't scroll)
- [ ] Find a way to browse navigation on mobile (switch between views / sections ?)
Oh god the old screenshots... >_>
Idea: find some way of converting from a Markdown file so it is easier to maintain, and I could add it to the repo so people can help me improve it. Summarizing and writing documentation is actually pretty hard!
(oh and also translations, why not)
Any suggestions for a very simple php library that converts basic Markdown to html ? For example I would have help.md
, the php returns html code that can be output in the template and on which I can do a few additional transforms.