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 docs for TimeSeries and RNANews connectors. #18

Merged
merged 19 commits into from
Aug 28, 2024
Merged

Conversation

Eskils
Copy link
Contributor

@Eskils Eskils commented Aug 19, 2024

This PR aims to supply documentation for new connectors and how to use them with dashboards and Highcharts.

Considerations

  • RNANews is listed as a capability in time-series.md, like Morningstar has in their documentation. This could however give the wrong impression to the reader of the docs as our connector treats RNANews as a separate connector from TimeSeries.
    • Consider if it should be removed from the list

@Eskils Eskils self-assigned this Aug 19, 2024
@Eskils Eskils requested a review from bre1470 August 20, 2024 08:29
@Eskils Eskils marked this pull request as ready for review August 20, 2024 08:29
Eskils and others added 4 commits August 22, 2024 12:23
* Specify font
* Fix assigning data to chart
* Use area with gradient fill
* Update docs to match changed demo

---------

Co-authored-by: bre1470 <[email protected]>
Copy link
Member

@bre1470 bre1470 left a comment

Choose a reason for hiding this comment

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

Some updates are needed:

  • I agree with your comment, but we should at least cross reference, so that people find the RNA news connector. You did this already, afaik. So this point is done.
  • All documents should reflect the renaming from @highcharts/morningstar-connectors to @highcharts/connectors-morningstar.
  • The standalone bundle is now connectors-morningstar.js.
  • Maybe link to the corresponding Morningstar API in a footnote, in case someone is interested in technical details.

@Eskils Eskils requested a review from bre1470 August 22, 2024 12:34
Copy link
Member

@bre1470 bre1470 left a comment

Choose a reason for hiding this comment

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

Looks good! 👍

@bre1470 bre1470 merged commit 1c2308d into main Aug 28, 2024
3 checks passed
@bre1470 bre1470 deleted the feature/add-docs branch August 28, 2024 12:51
@bre1470 bre1470 added this to the v0.2.0 milestone Aug 30, 2024
@bre1470 bre1470 changed the title Add docs for TimeSeries and RNANews connectors Added docs for TimeSeries and RNANews connectors. Aug 30, 2024
@bre1470 bre1470 added the documentation Improvements or additions to documentation label Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants