cFS icon indicating copy to clipboard operation
cFS copied to clipboard

Suggestion: Documentation rework

Open EzraBrooks opened this issue 8 years ago • 2 comments

I've started working on Markdown-izing documentation on my fork of this repository so it's easier to navigate via GitHub's interface. I plan to convert all plain-text, PDF, and Word documents to Markdown, but leave Doxygen docs intact since they're generated (However, on that subject, on the CACTUS fork of cFE I made a Travis job that automatically builds Doxygen docs and deploys them to GitHub Pages). I can open a PR here once the conversion is complete if the cFE team would like to integrate that change in the main repo.

EzraBrooks avatar Sep 27 '17 14:09 EzraBrooks

Are you still interested in contributing? See the bundle starting at https://github.com/nasa/cFS (there's a rc-6.6.0a branch that will move to master as soon as internal testing is complete), converting to markdown is definitely a goal for all the related documentation. We've also got a few wiki's from an internal Trac system we've also tagged for conversion. Any help would be great!

skliper avatar May 31 '19 20:05 skliper

CCB 20191001: General documentation (overviews, etc) markdown is preferred. Still using doxygen for code documentation. Preference to move away from word documents.

Preference is to actually produce the API documents using doxygen (forward work)

HTML to markdown - tool exists (maybe part of python markdown library) pandoc does pdf to markdown

skliper avatar Oct 02 '19 16:10 skliper