[
https://issues.apache.org/jira/browse/FINERACT-834?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17160115#comment-17160115
]
Michael Vorburger commented on FINERACT-834:
--------------------------------------------
Both a (short, succinct) demo video and a paragraphs with words about it on the
README could be neat. If you want more than a paragraph, let's be careful not
to bloat the README any further, but instead put it into
[https://github.com/apache/fineract/tree/develop/docs] and just link to it from
the README. - If you want to wait for [~ptuomola] to review and merge
[https://github.com/apache/fineract/pull/1169] and then do the demo video using
[https://www.fineract.dev|https://www.fineract.dev/] instead of localhost, that
would be super cool IMHO.
> Minor quick win: Please raise very small PR documenting Swagger use on README
> -----------------------------------------------------------------------------
>
> Key: FINERACT-834
> URL: https://issues.apache.org/jira/browse/FINERACT-834
> Project: Apache Fineract
> Issue Type: Sub-task
> Reporter: Michael Vorburger
> Priority: Major
>
> Based on some of the discussion in
> https://github.com/apache/fineract/pull/629 (which got superseded by
> https://github.com/apache/fineract/pull/695), I think it would be very useful
> to have a short line (or a or two paragraph, max) in
> https://github.com/apache/fineract/blob/develop/README.md#apache-fineract-platform-api
> which simply explains how one actually may currently use the Swagger UI, as
> it currently is.
> I will just be completely honest and admit that personally I do not actually
> know how! ;-) Is there a special URL one has to access? Does one need to
> locally install anything?
> [~kangbreder] would you like to do this? Please do raise 1 small PR with ONLY
> this README change.
> [~awasum] [~sanyam] ([~sanyam96] ?) FYI
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
