-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Labels
enhancementNew feature or requestNew feature or request
Description
URL(s) with the issue:
- https://github.com/DBOMproject/docs
- https://github.com/DBOMproject/docs/blob/master/source/use-cases.rst
- https://github.com/DBOMproject/docs/blob/master/source/getting-started.rst
- https://github.com/DBOMproject/docs/blob/master/source/faq.rst
- ...
Description of the issue:
Apparently sphinx-using-restructured-text has been decided on for creating documentation. Since this is github, is there a reason github markdown is not being used. Note they are very very similar and markdown is supported natively on github so you don't need things like makefiles to create it and webpages will display both raw and formatted text in a more intuitive way to average user. I would propose:
- using github markdown, or
- an faq explaining why you (whoever you is) decided to make life harder for the average user (yes it's snarky)
Submitting a pull request?
Are you willing to submit a pull request to solve this issue? (Yes/No): Maybe, Yes if you switch to GFM, no is you decide (thru whatever undocumented-as-yet process decisions are made) to stick with sphinx
santosomar
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request