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

Split developer documentation and user manual #349

Closed
stefandesu opened this issue May 12, 2019 · 5 comments
Closed

Split developer documentation and user manual #349

stefandesu opened this issue May 12, 2019 · 5 comments
Labels
cleanup code cleanup, refactoring, testing... documentation Provide sufficient documentation
Milestone

Comments

@stefandesu
Copy link
Member

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).

@stefandesu stefandesu added the documentation Provide sufficient documentation label May 12, 2019
@stefandesu stefandesu added this to the 1.0.0 milestone May 12, 2019
@nichtich
Copy link
Member

See #337 (partly duplicate). We're working on it in the docs/ directory. A build should create files user-manual-de.html and user-manual-en.html, copied into dist/.

@nichtich nichtich modified the milestones: 1.0.0, 1.2.0 Jun 28, 2019
@nichtich
Copy link
Member

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.

@nichtich
Copy link
Member

nichtich commented Jul 2, 2019

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.

@nichtich nichtich added the cleanup code cleanup, refactoring, testing... label Jul 2, 2019
@nichtich
Copy link
Member

nichtich commented Jul 2, 2019

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.

@nichtich nichtich mentioned this issue Nov 6, 2019
3 tasks
@nichtich
Copy link
Member

nichtich commented Dec 2, 2019

This also includes documenting new features such as concept lists which have not been covered in documentation yet.

nichtich added a commit that referenced this issue Dec 2, 2019
@nichtich nichtich closed this as completed Dec 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup code cleanup, refactoring, testing... documentation Provide sufficient documentation
Projects
None yet
Development

No branches or pull requests

2 participants