LoopBack 3 API Documentation (broken url)

[kamilml]

URL of the page

http://apidocs.loopback.io/loopback

Nature of the issue

The url of the LoopBack API Documentation for v3 is broken

Expected behavior

Load the page

Actual behavior

Internal Server Error

Suggested resolution

Please fix the url guys :)

[shubhamp-sf]

@kamilml I've locally build the docs from lb3 repo and unofficially published it on vercel.

https://loopback3-api-docs.vercel.app/

See if it has what you're looking for.

[GrooveCS]

It currently appears that http://apidocs.loopback.io/loopback is a broken link.

The root location of https://loopback.io/lb3 is located here.

The loopback 3 documentation is located https://loopback.io/doc/en/lb3/ and appears to be working correctly.

Can we close this matter, or does something else exist?
Can you clarify the issue?

[dhmlau]

@GrooveCS, I believe our intent is to see how to "resurrect" the LB3 API docs. Although LB3 has reached end of life, we're still seeing downloading on LB3 (loopback module).

Since the old LB3 API docs was built before my time and @shubhamp-sf seems to have a working version, I wonder if we could take that approach and publish it in our docs site. @raymondfeng @achrinza, thoughts?

[achrinza]

I think this is one of those more straightforward things that we just didn't implement.

IIRC, @shubhamp-sf 's links are the output of jsdoc -r . with minor modifications. The main difference is that apidocs.loopback.io also had a package version selector.

We should be able to reimplement @shubhamp-sf's work:

1. Create a loopbackio/jsdoc repo
2. Write a script that generates HTML jsdoc for LB3 packages
3. Use Github Actions to publish those HTML files
4. Ask OpenJSF to point the subdomain to Github Pages

As for implementing a package version selector, I think we can spin that as a separate task to keep this initial implementation straightforward.

WDYT?

[dhmlau]

sounds good to me!