posix_ipc icon indicating copy to clipboard operation
posix_ipc copied to clipboard

Published 20 hours ago • verified publisher icon osvenskan

Convert doc to Markdown

Open osvenskan opened this issue 3 years ago • 5 comments

Summary

Currently my personal site is the primary repository for the documentation. Since it's formatted in HTML, it's less easy to read on GitHub than it could be. If the doc was in Markdown, it's be easier to change the project's organization to have GitHub be the primary source of both the doc and source code.

osvenskan avatar Jun 13 '21 14:06 osvenskan

I'd be willing to look into this if help is still wanted!

christopolise avatar Jun 15 '22 17:06 christopolise

Hi @christopolise, thanks for the offer! I created a new branch for this work. I integrated the work from @GreatBahram from #31 and now I'd like to build on that. There are two tasks you could take on. One is to convert the usage instructions in ReadMe.html into markdown in usage.md. Another is to convert history.html to markdown. Any progress on these would be appreciated.

https://github.com/osvenskan/posix_ipc/tree/29-convert-doc-to-markdown

osvenskan avatar Jul 07 '22 14:07 osvenskan

Will do! I am assuming I should just fork the repo and then make a PR when I've made the changes?

christopolise avatar Jul 07 '22 16:07 christopolise

Yep, that works for me, as long as I can merge to https://github.com/osvenskan/posix_ipc/tree/29-convert-doc-to-markdown. Thanks!

osvenskan avatar Jul 07 '22 16:07 osvenskan

Finished these edits and open up a PR #33 . Let me know if there is anything else that needs to be done!

christopolise avatar Jul 08 '22 04:07 christopolise

resolved with the release of 1.1.0

osvenskan avatar Nov 25 '22 17:11 osvenskan