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

docs: Complete Documentation Rewrite #2108

Merged
merged 130 commits into from
Mar 15, 2022
Merged

docs: Complete Documentation Rewrite #2108

merged 130 commits into from
Mar 15, 2022

Conversation

cutterbl
Copy link
Collaborator

@cutterbl cutterbl commented Jan 22, 2022

This is an exhaustive overhaul of documentation of Big Calendar. Here's the basic highlights:

  • All documentation has been moved to Storybook
  • Storybook has been upgraded
  • All previous Examples have been updated and included
  • Stories, with mdx docs and specific examples, have been created for every prop
  • Addon stories, to include examples and prop stories, have been created for DnD
  • Guide stories have been created to talk about Custom Styling, Custom Views, information about Big Calendar and Dates, and a guide on dealing with Timezones
  • General documentation contribution guidelines have been included
  • A GitHub workflow is included that will automatically build and deploy documentation to GitHub pages, after successful Release workflow (requires review and discussion with @jquense)

@jquense There is an issue with testing, after some of the dependency upgrades, that appear directly related to the babel-preset-jason preset in conjunction with Babel and Jest.

Submitting this now for review/help/feedback.

Note: This does require a yarn install for fresh dependencies

@cutterbl cutterbl linked an issue Jan 27, 2022 that may be closed by this pull request
@ziga-miklic
Copy link

Should the new docs include info about the utility functions? For example, we found the firstVisibleDay() and lastVisibleDay() useful in our project to get the current date range.

I also did a quick StackOverflow / GitHub search and it appears that others are using them as well.

@cutterbl
Copy link
Collaborator Author

@ziga-miklic With all date math now being handled directly from the localizer, it might be a good idea to write some extensive localizer documentation. Good suggestion, I'll take a look at that.

cutterbl and others added 2 commits February 3, 2022 16:54
This corrects #1617, fixing the display of the TimeGutter times as well as correcting event layouts from the momentLocalizer, while maintaining date math within the localizers.
## [0.38.7](v0.38.6...v0.38.7) (2022-02-03)

### Bug Fixes

* Correct display of beginning DST ([bd8e0e9](bd8e0e9)), closes [#1617](#1617)
@ziga-miklic
Copy link

@cutterbl Thank you for adding the docs for the Localizer utility methods. 👏 This would give us all the info we needed for our past use case.

I left a few comments of things that I noticed when reading the docs. Please take a look.

I also noticed that the "Run examples locally" section in README.md may need to be updated as it's still referencing the yarn examples command that has been removed in this PR.

@cutterbl
Copy link
Collaborator Author

@ziga-miklic Nice catches on all of those. Late night/early morning fat fingering. Good to have second set of eyes. Thanks for looking out.

@jquense
Copy link
Owner

jquense commented Mar 14, 2022

@cutterbl there is really too much for me to look at here, i'm sure it's great. this is effectively your repro now, so don't wait on me for anything 👍

@cutterbl
Copy link
Collaborator Author

@jquense Appreciate the vote of confidence there. As the owner though, only you can control the settings for the GitHub Pages, which is the final item in question here.

@jquense
Copy link
Owner

jquense commented Mar 14, 2022

what specifically do you need me to check or toggle? happy to do it

@cutterbl
Copy link
Collaborator Author

cutterbl commented Mar 14, 2022

@jquense just need to know what folder is setup with the 'gh-pages' branch in your Pages settings. I figure it's 'root', but need to know for sure so I don't take down the docs site.

@jquense
Copy link
Owner

jquense commented Mar 15, 2022

it is root 👍 let me know if you want it to be something else

@cutterbl cutterbl changed the title Complete Documentation Rewrite docs: Complete Documentation Rewrite Mar 15, 2022
@cutterbl cutterbl merged commit e5721ef into master Mar 15, 2022
@cutterbl cutterbl deleted the chore/storybookUpgrade branch March 15, 2022 18:34
@github-actions
Copy link

🎉 This PR is included in version 0.39.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

@cutterbl
Copy link
Collaborator Author

@jquense New docs are live

@jquense
Copy link
Owner

jquense commented Mar 16, 2022

they look great! awesome work 👍

@dpd73
Copy link

dpd73 commented Mar 16, 2022

Great work people. Dates/Timezone stuff particularly useful.

FYI, small typo on https://jquense.github.io/react-big-calendar/examples/index.html?path=/story/guides-understanding-dates--page

...culture, regarless of any offsets.

should be "regardless"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Seeking Assistance With New Documentation
9 participants