search

invertase / notifee

⚛️ A feature rich notifications library for React Native.
https://notifee.app
Apache License 2.0
1.87k stars 226 forks source link

docs: website is outdated! Use source: https://github.com/invertase/notifee/tree/main/docs-react-native/react-native/docs #559

Open nateshmbhat opened 2 years ago

helenaford commented 2 years ago

thanks for opening this issue. Looks like the website hasn't updated but you can find release notes here (https://github.com/invertase/notifee/commit/cc58d057871e4c6b928c112ff877c6beb6305d0a) in the meantime

github-actions[bot] commented 1 year ago

Hello 👋, to help manage issues we automatically close stale issues.

This issue has been automatically marked as stale because it has not had activity for quite some time.Has this issue been fixed, or does it still require attention?

This issue will be closed in 15 days if no further activity occurs.

Thank you for your contributions.

github-actions[bot] commented 1 year ago

Hello 👋, to help manage issues we automatically close stale issues.

This issue has been automatically marked as stale because it has not had activity for quite some time.Has this issue been fixed, or does it still require attention?

This issue will be closed in 15 days if no further activity occurs.

Thank you for your contributions.

helenaford commented 1 year ago

keep open.

github-actions[bot] commented 1 year ago

Hello 👋, to help manage issues we automatically close stale issues.

This issue has been automatically marked as stale because it has not had activity for quite some time.Has this issue been fixed, or does it still require attention?

This issue will be closed in 15 days if no further activity occurs.

Thank you for your contributions.

github-actions[bot] commented 1 year ago

Hello 👋, to help manage issues we automatically close stale issues.

This issue has been automatically marked as stale because it has not had activity for quite some time.Has this issue been fixed, or does it still require attention?

This issue will be closed in 15 days if no further activity occurs.

Thank you for your contributions.

rvasseur31 commented 1 year ago

Hi @helenaford, do you have any update on this ?

elibroftw commented 1 year ago

@helenaford , the website links to outdated release notes. If notifee does not want to keep this page synced with the release notes through an automatied script, then I suggest this page be deleted and that the release note link on the sidebar image

be directed to github rather than the outdated page.

VivienTournie commented 1 year ago

Hi @helenaford , any update on this issue ?

mikehardy commented 1 year ago

Definitely not stale!

github-actions[bot] commented 11 months ago

Hello 👋, to help manage issues we automatically close stale issues.

This issue has been automatically marked as stale because it has not had activity for quite some time.Has this issue been fixed, or does it still require attention?

This issue will be closed in 15 days if no further activity occurs.

Thank you for your contributions.

mikehardy commented 10 months ago

The stale bot is still faster than I am but I make inevitable progress

github-actions[bot] commented 9 months ago

Hello 👋, to help manage issues we automatically close stale issues.

This issue has been automatically marked as stale because it has not had activity for quite some time.Has this issue been fixed, or does it still require attention?

This issue will be closed in 15 days if no further activity occurs.

Thank you for your contributions.

liamjones commented 9 months ago

Not stale

mikehardy commented 9 months ago

This is an issue common to all the invertase react-native repos at the moment. react-native-firebase is undergoing a documentation refresh at the moment and the sticking point for us always "the docs we manually write" vs "the API reference". In the past we made great efforts to have the API reference match the manual docs exactly so things looked coherent but unfortunately the auto-generation of the manual docs is something that CDNs and web frameworks can't really handle dynamically, and if we generate the API docs statically then they aren't themed correctly like the manual docs.

This may not seem important but it's one of those little visual things we were trying to get 100% correct and it just wasn't happening.

We've decided last week at a high level that auto-generation of API docs is the only way to make those maintainable + keep them up to date (obviously) but importantly we've decided to relax our success criteria for visual fidelity of API vs manual docs which unblocks this whole thing at a design level so we can just get on with implementation

Hoping to have docs published and up to date then, as that is kind of a critical matter...

github-actions[bot] commented 8 months ago

Hello 👋, to help manage issues we automatically close stale issues.

This issue has been automatically marked as stale because it has not had activity for quite some time.Has this issue been fixed, or does it still require attention?

This issue will be closed in 15 days if no further activity occurs.

Thank you for your contributions.

johnf commented 6 months ago

not stale

mikehardy commented 1 month ago

We've got some progress at long last!

https://docs.page/invertase/notifee~docs-page

built from branch here https://github.com/invertase/notifee/tree/docs-page

And I have a "yes" / approval as an answer to this question which should finally resolve the "okay, but how do we publish the reference API with the types built from source, huh?"

Are you okay with whatever I currently consider "the fastest possible way to get reference typedoc" up, most likely a firebase hosting site connected to an app that is also used directly for Notifee example + demonstration (to host a cloud function that can send messages to the app install requesting them) ?