search

RITlug / teleirc

Go implementation of a Telegram <=> IRC bridge for use with any IRC channel and Telegram group
https://docs.teleirc.com/
GNU General Public License v3.0
138 stars 46 forks source link

Refactor documentation into smaller pages (to make it more readable) #118

Closed jwflory closed 5 years ago

jwflory commented 5 years ago

Summary

Break up documentation from single, monolithic pages to more modular, bite-sized pages

Background

We have documentation, but it is not easy to read. It is wordy and sometimes confusing. Our docs should take on small topics and focus on those topics. This also helps our documentation's searchability and makes it easier to navigate (in other words, important information isn't buried).

Details

The installation page is in need of the most love. This page could be 3-4 pages. I was thinking to split it up this way:

Outcome

Documentation is more useful to non-developers, easier to find key information, better visibility into different parts of Teleirc

jwflory commented 5 years ago

Discussed in 2019-02-02 RITlug developers' meeting. This issue is targeted for the v1.3 milestone, estimated to release on March 2nd, 2019.

I volunteered to work on this during this sprint. It's something I've wanted to do for a long time. I'm targeting for completion the Saturday, Feb. 16th developers' meeting.

I'll probably start working on this in a feature branch gradually.

jwflory commented 5 years ago

Discussed in 2019-02-09 RITlug developers' meeting.

Not yet started. I plan to split off main installation page into several smaller pages. Expecting the main docs page to be split up by next developers' meeting on Saturday, Feb. 16th.