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

Add quick-start documentation in the README #48

Closed
joffrey-bion opened this issue Oct 2, 2017 · 2 comments
Closed

Add quick-start documentation in the README #48

joffrey-bion opened this issue Oct 2, 2017 · 2 comments

Comments

@joffrey-bion
Copy link
Owner

Even without a comprehensive and detailed documentation about the ins and outs of Livedoc, we should at least provide a quickstart guide for each way of using Livedoc:

  • using livedoc-core and creating a LivedocReader (and potentially a controller or some sort of access to the JSON documentation)
  • using livedoc-springmvc and creating a basic controller
  • using livedoc-springboot and application.properties

Also, of course, mention the UI webjar and how to use it.

@ST-DDT
Copy link

ST-DDT commented Oct 2, 2017

Also would it be possible for you to host the ui somewhere so that it is easier to look at? (and link it in the readme)

Maybe one some of these mysterious github.io pages?

@joffrey-bion
Copy link
Owner Author

@ST-DDT Targeting someone's own doc from an externally-hosted UI was so far not possible because of #35.

Do you mean a UI to access some sort of showcase doc like in the original JsonDoc project?
That would indeed be possible, and it is planned, it was just not my priority right now, as I'm trying to have a clean and running lib before writing a showcase :) I'll open a separate issue for that.

For now, to have a glance at the UI, you may add the webjar to your dependencies and target /livedoc-ui.html on your own server.

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

No branches or pull requests

2 participants