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: update documentation for new v3.0 #328

Merged
merged 3 commits into from
Nov 15, 2024

Conversation

ghiscoding
Copy link
Contributor

@ghiscoding ghiscoding commented Nov 8, 2024

Hi there, I wanted to contribute back for the great work you've done on your new 3.0 release, so I've done a few search & replace (manually) with the info you've put in #316

There's a few notes though

  • I left a TODO in 1 of the settings Russian doc for the disableWeekdays option because I think the new option is the inverse of previous option settings.visibility.weekend?
  • the following options needs to be reviewed/updated or were not found in the docs because they might be new
    • locale
    • enableMonthChangeOnDayClick
    • selectedWeekends
    • timeMinHour
    • timeMaxHour
    • timeMinMinute
    • timeMaxMinute
    • onClickWeekDay
    • onClickTitle
    • onCreateDateRangeTooltip
    • labels
    • layouts
    • styles
    • setContext() new function

Another side note, for any potential URLs linking section names, they will need to be updated, for example a link to ## settings.visibility.positionToInput will change from

Hope that helps, cheers :)

@ghiscoding
Copy link
Contributor Author

side note, I saw you added a Ko-Fi link and I tried to send you one but I think there's no account for donation yet, mine is linked to PayPal. Maybe we have to wait couple days?

@uvarov-frontend
Copy link
Owner

@ghiscoding Unbelievable, thank you very much! I am now updating the site and your help is very useful.

I created a page on ko-fi, but I haven’t linked a bank account yet because my Russian account is not suitable for this. 😀 I will need to open a bank account in another country, I’m already doing it.


`Type: Function`

`Default: null`

`Options: getDays(day, date, HTMLElement, HTMLButtonElement, self) => void | null`
`Options: onCreateDateEls(day, date, mainElement, HTMLButtonElement, self) => void | null`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmm it looks like I missed the HTMLButtonElement, not sure what the new name should be. Same problem with line 172 just below

Copy link
Contributor Author

Choose a reason for hiding this comment

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

actually these onX actions internal code seem to only accept 2 arguments (self, cal), so all these new action docs might need to be updated with the 2 args. I'll leave that up to you to verify. :)

Copy link
Owner

Choose a reason for hiding this comment

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

Okay, don't worry, I'll figure it out, thanks for your help)


`Type: Function`

`Default: null`

`Options: getDays(day, date, HTMLElement, HTMLButtonElement, self) => void | null`
`Options: onCreateDateEls(day, date, mainElement, HTMLButtonElement, self) => void | null`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

same as above need to replace HTMLButtonElement with ...?

Copy link
Owner

Choose a reason for hiding this comment

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

Look at this line and this file as a whole:

onCreateDateEls!: (self: Calendar, dateEl: HTMLElement) => void;

This file contains all types and default values ​​for all options.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I left those as comments for review, I think I'll leave the rest to you 😉

@uvarov-frontend
Copy link
Owner

@ghiscoding I finally finished with the new documents, it was very boring. I wrote new documents in Russian and then translated them through AI, please let me know if somewhere there is an inaccurate or erroneous translation. Thanks for your help!

You can also create new documentation pages if something is not in the documentation. Just create an mdx file in the appropriate section and it will appear on the site.

@uvarov-frontend uvarov-frontend merged commit 4609288 into uvarov-frontend:main Nov 15, 2024
@ghiscoding
Copy link
Contributor Author

great to hear it was helpful even if it was boring to review 😉

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

Successfully merging this pull request may close these issues.

2 participants