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

Seeking Assistance With New Documentation #2115

Closed
cutterbl opened this issue Jan 27, 2022 · 4 comments · Fixed by #2108
Closed

Seeking Assistance With New Documentation #2115

cutterbl opened this issue Jan 27, 2022 · 4 comments · Fixed by #2108
Labels
chore dependencies Pull requests that update a dependency file enhancement help wanted

Comments

@cutterbl
Copy link
Collaborator

Issue:
The current BigCalendar documentation site is not in sync with the repository, missing a number of updates and features. Currently there is no automated process for updating the documentation site (GitHub page) when new packages are created.

Solution:
PR #2108 is a complete rewrite of Big Calendar documentation, located in the chore/storybookUpgrade branch. Some of it's highlights include:

  • 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)

ToDo:
I need help in reviewing this documentation, and getting the testing straightened out. A number of dependencies were updated for this (Read: requires yarn install), and though all 'build' processes fine something in the Babel config is conflicting with Jest.

Any and all assistance is appreciated.

@jquense
Copy link
Owner

jquense commented Jan 27, 2022

new docs look great! I'd be happy to help review the tooling changes, but don't have a time of time (as i'm sure you noticed) to look over docs thoroughly

@cutterbl cutterbl added chore dependencies Pull requests that update a dependency file enhancement help wanted labels Jan 27, 2022
@cutterbl
Copy link
Collaborator Author

@jquense Much appreciate the look at tooling. Also would need some assist with the auto doc deploy workflow, as that requires some info from you about the GitHub Pages setup for the repo.

@cutterbl cutterbl linked a pull request Jan 27, 2022 that will close this issue
@decimoseptimo
Copy link

decimoseptimo commented Jan 28, 2022

I'm already helping at definitely typed. I'll take a look at this later, I'm still not aware of this update.

@cutterbl
Copy link
Collaborator Author

cutterbl commented Feb 3, 2022

@jquense Have you had any time/luck looking at the tooling?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore dependencies Pull requests that update a dependency file enhancement help wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants