modulesync icon indicating copy to clipboard operation
modulesync copied to clipboard

Published 20 hours ago • verified publisher icon voxpupuli

Create hosted documentation from README

Open bittner opened this issue 7 years ago • 4 comments
trafficstars

The README is pretty lengthy now. To make it easier to understand and adopt we should turn it into a dedicated documentation, splitting up the different topics into separate chapters.

We may use Read the Docs for this. It's possible to continue to use Markdown, though reStructuredText is recommended.

See also

bittner avatar May 27 '18 08:05 bittner

It sounds like a nice idea but I'm not sure how to get this started. We probably need a repo admin like @bastelfreak to configure things because I have no permissions.

ekohl avatar Jun 03 '18 07:06 ekohl

I'm not sure whether we actually need admin permission to get this going.

Would still be interesting to know, though: Who has admin permissions on this repository and could help? (@bastelfreak is currently on vacation according to his profile.)

bittner avatar Feb 26 '19 11:02 bittner

I'm not sure where admin permissions are needed at the moment. More detailed docs are always nice, so if you want to rework it to RST go for it. As soon as we have something that can be released we can take a look on ways to publish it?

bastelfreak avatar Feb 28 '19 07:02 bastelfreak

Note that rubydoc automatically generates documentation as well which includes the README. https://www.rubydoc.info/gems/modulesync/1.2.0 does have a table of contents for example.

ekohl avatar Jul 20 '20 22:07 ekohl