-
Notifications
You must be signed in to change notification settings - Fork 5
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
Split developer documentation and user manual #349
Comments
See #337 (partly duplicate). We're working on it in the |
The German user-manual is an independent document, while the english is collected from the full manual. To close this issue we should move the English user manual but this is less urgent. |
The API reference, build with vue-styleguide should also be split up into a independent document because build time is slow and inflexible compared to Pandoc. |
The user-manual references boostrap.css from dist directory so it won't look nicely if no build has been run (e.g. if someone tries to only work on the manual), this should also be fixed. |
This also includes documenting new features such as concept lists which have not been covered in documentation yet. |
The user manual and developer documentation should not be in one place, but rather separate. The former should be linked from the application, while the latter only needs to be linked from the README. Also, certain information from the developer manual should be available in the README as well (already started).
The text was updated successfully, but these errors were encountered: