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

Make documentation a first class citizen and switch to markdown #21

Closed
h-man2 opened this issue Oct 5, 2021 · 1 comment
Closed

Make documentation a first class citizen and switch to markdown #21

h-man2 opened this issue Oct 5, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@h-man2
Copy link
Contributor

h-man2 commented Oct 5, 2021

Is your feature request related to a problem? Please describe.
If one looks at the USE "manual" it is completely outdated (last version is from 2007).
The switch to mardown would couple the documentation and changes, because of

  1. Markdown files can be rendered in GitHub, so documentation is integrated inton the project website
  2. A final PDF could still be generated so nothing is lost

Describe the solution you'd like
In a frist step: translate the LaTex based documentation to Markdown.
Afterwards add build-step to maven to genrate the PDF-manual and to generate some API-Docs

Describe alternatives you've considered
Further using LatTex.

Additional context
n/a

@h-man2 h-man2 added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 5, 2021
h-man2 added a commit that referenced this issue Oct 25, 2021
@h-man2
Copy link
Contributor Author

h-man2 commented Oct 25, 2021

Was closed by #22

PDF Generation is questionable. Maybe just stay with GitHub Markdown.

@h-man2 h-man2 closed this as completed Oct 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant