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

Added CLI command for API docs. #34

Merged
merged 11 commits into from
Sep 22, 2024
Merged

Added CLI command for API docs. #34

merged 11 commits into from
Sep 22, 2024

Conversation

bre1470
Copy link
Member

@bre1470 bre1470 commented Sep 13, 2024

Use npx connectors-morningstar api.

@bre1470 bre1470 added the enhancement New feature or request label Sep 13, 2024
@bre1470 bre1470 self-assigned this Sep 13, 2024
src/CLI/Library/APIServer.ts Fixed Show fixed Hide fixed
src/CLI/Library/APIServer.ts Fixed Show fixed Hide fixed
src/CLI/Library/APIServer.ts Fixed Show fixed Hide fixed
@bre1470 bre1470 marked this pull request as ready for review September 19, 2024 12:12
@bre1470 bre1470 requested a review from Eskils September 19, 2024 12:12
Copy link
Contributor

@Eskils Eskils left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a big PR, so I spent more time testing rather that looking though code.

This is great because it looks and works like the rest of the Highcharts API Reference, and also works offline.

Requested changes:

Some things on the API docs website at localhost:8005 did not work like I expected:

  • Navigating directly to an option (e.g. http://localhost:8005/RNANews.localization.currency) does not work. The home page is shown instead. This also means the links in the div#body does not work.

  • The class reference does not exist.

    • If this is not to be implemented: Consider hiding this link.
    • If it is to be kept: consider a different text. It now reads For modifying the chart at runtime. See the [class reference](http://localhost:8005/class-reference/classes.list).
Screenshot 2024-09-20 at 07 49 25
  • Missing copyright year and version in footer
Screenshot 2024-09-20 at 07 50 56
  • The search field does not work. Console shows 404 search.json
Screenshot 2024-09-20 at 13 26 23
  • Clicking “JS API Reference” in the top header links to the incorrect page which does not exist:
Screenshot 2024-09-20 at 13 43 13

src/CLI/connectors-morningstar.ts Show resolved Hide resolved
@bre1470 bre1470 requested a review from Eskils September 20, 2024 14:03
Copy link
Contributor

@Eskils Eskils left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is excellent – well done!

@bre1470 bre1470 merged commit 3942072 into main Sep 22, 2024
5 checks passed
@bre1470 bre1470 deleted the cli/api branch September 22, 2024 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants