chewing/chewing-editor

Documnets for using chewing editor

Opened this issue · 9 comments

david50407 commented

Extracted from #202.

jserv commented 7 days ago
In-program online help would be better than the entries of Wiki pages from users' perspective.

david50407 commented 7 days ago
@jserv maybe we can try to place a "Help" button in on the interface and link it to github wiki page first?

jserv commented 6 days ago
@david50407, Good idea. However, I prefer having in-program help rather than linking to somewhere at first sight.

For now, we can just create some documents on GitHub Wiki and add a "Help" button to link to the wiki page.

jserv commented

@david50407, I have added you to chewing-editor writer list. Feel free to contribute something to Wiki.

Billy4195 commented

@jserv, May I also help to write the document on Wiki?

  • 👍2
david50407 commented

@Billy4195 everyone can contribute to wiki, enjoy it! 🎉

Daichou commented

@Billy4195 , Whether we should add usage(how to use)?

Billy4195 commented

@Daichou I'm adding it now, but I don't have the permission to add sidebar(like a navbar).
@jserv Can you give me the permission to add the sidebar, or create one, then we can modify it.

jserv commented

@david50407, Please validate and confirm necessary permissions requested by @Billy4195 .

david50407 commented

Hi @Billy4195, thanks for the contribution first, and I think that you should only add a new page and edit it is fine. The page you created will auto displayed on the sidebar. 😄

Billy4195 commented

Hi @david50407, the sidebar I mentioned above is like the omniauth wiki right side have a more clear navbar for user to read.
But for now the wiki still have a little pages to display, I think the sidebar can be added later when the wiki pages become more complicated.

Billy4195 commented

I have added a wiki link in "About Chewing editor" box in #217