Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion: Documentation rework #1

Open
EzraBrooks opened this issue Sep 27, 2017 · 2 comments
Open

Suggestion: Documentation rework #1

EzraBrooks opened this issue Sep 27, 2017 · 2 comments

Comments

@EzraBrooks
Copy link

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.

@skliper
Copy link
Contributor

skliper commented May 31, 2019

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 skliper transferred this issue from nasa/cFE May 31, 2019
n8jones pushed a commit to n8jones/cFS that referenced this issue Jul 2, 2019
@skliper
Copy link
Contributor

skliper commented Oct 2, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants