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

UI : Some questions. #119

Closed
sadikr opened this Issue Jul 7, 2015 · 3 comments

Comments

Projects
None yet
2 participants
@sadikr
Copy link

sadikr commented Jul 7, 2015

  1. For jsondoc-ui, why we have named html file to "jsondoc-ui"? should not it be "index.html"
    Reason : I've integrated JSONDoc in one of my application, where I'm generating jsondoc-ui folder via defining dependency in pom.xml. And when I try to access the doc with url like ..
    http://localhost:8080/json-doc/
    This url gives me nothing, I've to specify that html file to access my app's api-doc.

  2. I've gone through the jsondoc-ui.html file, why aren't we separating the html,css,js code?

Sorry! if this is not the place to raise such question.

@sadikr sadikr changed the title Questions... UI : Some questions. Jul 7, 2015

@fabiomaffioletti

This comment has been minimized.

Copy link
Owner

fabiomaffioletti commented Aug 3, 2015

Hello and thank you for your questions. Here are my answers:

  1. index.html is usually a name that is used by everyone to indicate the main (or welcome, or home) page. I wanted to avoid to overlap with that concept. In your application you can always map the /json-doc path to the jsondoc-ui.html view.
  2. This is a good point. Currently there are two projects: jsondoc-ui and jsondoc-ui-webjar. I wanted to consolidate them and have only one, but I did not have time to do that. In any case, as a first step, it's possible (and good) to separate css/js from the html. It's a low priority task, but I'll definitely do that soon or later ;) Opening an issue right now about that.
@sadikr

This comment has been minimized.

Copy link
Author

sadikr commented Aug 4, 2015

@fabiomaffioletti : Got the points. 👍 . Do let me know if you want help on separating css/js from html. I am ready to contribute.

@fabiomaffioletti fabiomaffioletti added this to the 1.1.16 milestone Aug 4, 2015

@fabiomaffioletti fabiomaffioletti self-assigned this Aug 4, 2015

@fabiomaffioletti

This comment has been minimized.

Copy link
Owner

fabiomaffioletti commented Aug 4, 2015

Just done. Will be released in the next days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment