Skip to content

Documentation Website #347

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.

Sign up for GitHub

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

Jump to bottom
Merged
kurkle merged 9 commits into from
Mar 14, 2021
Merged

Documentation Website #347

kurkle merged 9 commits into from
Mar 14, 2021

Conversation

@etimberg
Copy link
Member

@etimberg etimberg commented Mar 9, 2021 •
edited
Loading

Adds a doc site based on docusaurus. My thinking is that we deploy to the gh-pages branch and it will appear as https://www.chartjs.org/chartjs-plugin-annotation. This would be similar to the Smith Chart docs.

To Do

  • Line annotation docs
  • Interaction docs
  • Decide what to do with the samples

annotation docs

Resolves #343
Resolves #336
Resolves #294
Resolves #217

@etimberg etimberg requested a review from kurkle March 9, 2021 00:26
kurkle
kurkle reviewed Mar 9, 2021
View reviewed changes
Copy link
Member

@kurkle kurkle left a comment

Choose a reason for hiding this comment

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

Couple of comments. Great work!

@stockiNail
Copy link
Collaborator

stockiNail commented Mar 9, 2021

Couple of comments. Great work!

Really great! I think that was needed (in my opinion in all projects) because only the README is not enough when teh configuration and features are growing!

Looking forward to help if needed (as soon as I can.. :( ).

@stockiNail
Copy link
Collaborator

stockiNail commented Mar 9, 2021

@etimberg @kurkle as promised in another PR/issue I had started creating a README with the tables of options (style CHART.JS) (see my branch https://github.com/pepstock-org/chartjs-plugin-annotation/tree/readme#global-options) but it was (and is) not enough.

@etimberg
Copy link
Member Author

etimberg commented Mar 9, 2021

That's really helpful @stockiNail! I'll cross reference your tables against the docs as I write them. I think I'll be able to get the remaining doc pages done tonight.

LeeLenaleee
LeeLenaleee reviewed Mar 9, 2021
View reviewed changes
kurkle
kurkle previously approved these changes Mar 10, 2021
View reviewed changes
@etimberg etimberg marked this pull request as ready for review March 10, 2021 21:58
@kurkle kurkle merged commit 36ff4c3 into chartjs:master Mar 14, 2021
@etimberg etimberg deleted the docs branch March 14, 2021 14:51
@LeeLenaleee LeeLenaleee mentioned this pull request Mar 19, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@LeeLenaleee LeeLenaleee LeeLenaleee left review comments

@kurkle kurkle kurkle approved these changes

Assignees

No one assigned

Labels

documentation

Projects

None yet

Milestone

No milestone

4 participants

@etimberg @stockiNail @kurkle @LeeLenaleee