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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #66

Closed
de-jcup opened this issue May 27, 2018 · 3 comments
Closed

Improve documentation #66

de-jcup opened this issue May 27, 2018 · 3 comments

Comments

@de-jcup
Copy link
Owner

de-jcup commented May 27, 2018

Currently the documentation for the editor is ... poor.
Either introduce a full blown documentation like in EGradle or do just a Wiki help.
@de-jcup
Copy link
Owner Author

de-jcup commented Jun 4, 2018

  • document .ditaa and .plantuml editors

@kwah-gh
Copy link

kwah-gh commented Jul 20, 2018 •
edited

Some more things to consider:

  • Explain how to set up just documentation project. Currently wiki has a tip about EGradle java-full-multiproject-with-asciidoctor template. I have not been able to experiment with it (getting error about gradle not able to detect java version), but the name suggests that it is more than for writing documentation alone
  • Maybe also make a how to on hacking the plugin? ;)
  • Add tips on how to update 3rd-party plugins, e.g. plantuml. Or maybe make it configurable?

@de-jcup
Copy link
Owner Author

de-jcup commented Oct 12, 2018

With #147 an external asciidoctor instance can be used and cli arguments customized.
Documentation was improved in meanwhile too, so closing this issue now.

@de-jcup de-jcup closed this as completed Oct 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@de-jcup @kwah-gh