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.

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

Documentation update (#1618) #1728

Merged
merged 193 commits into from
Oct 11, 2023
Merged

Documentation update (#1618) #1728

merged 193 commits into from
Oct 11, 2023

Conversation

rrousselGit
Copy link
Owner

@rrousselGit rrousselGit commented Oct 4, 2022 •
edited
Loading

WIP PR for updating the site with 2.0 changes

  • add options to enable/disable code-generation and hooks
  • update all existing pages to use the new options
  • Add "about hooks" page
    • what are hooks
    • how to use hooks
  • Add "about code generation" page
    • what is codegen
    • why use codegen in riverpod
    • how to use codegen
  • Document Notifier/AsyncNotifier
  • Mention in StateNotifier docs that the Notifier API is preferred

@codecov
Copy link

codecov bot commented Oct 5, 2022 •
edited
Loading

Codecov Report

Merging #1728 (0c550d1) into master (cd43a71) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1728   +/-   ##
=======================================
  Coverage   95.24%   95.24%           
=======================================
  Files          53       53           
  Lines        2252     2252           
=======================================
  Hits         2145     2145           
  Misses        107      107

rrousselGit and others added 25 commits October 5, 2022 18:21
@rrousselGit
Move getting_started snippets
132115e
@rrousselGit
Update all getting_started snippets to use interactive codegen/hooks …
0c3db50 
…toggle
@rrousselGit
Fix broken translation links
4fa714b
@rrousselGit
Add "About hooks" page
64168de
@rrousselGit
Disable hooks by default
ba7a36e
@rrousselGit
Add barebone "about codegen" doc
12e13cb
@rrousselGit
Small refactor of codegen doc
0fc5a0a
@rrousselGit
Redirect to getting_started for codegen usage
1613cd1
@rrousselGit
Small update
8202650
@rrousselGit
Reorganize sidebar a bit
b15afc3
@rrousselGit
Extract snippets to dart files
9c861e4
@rrousselGit
deploy branch
c2e3368
@rrousselGit
Typo
637e38f
@rrousselGit
Fix mobile sidebar
88b4267
@rrousselGit
Merge branch 'master' of https://github.com/rrousselGit/river_pod int…
e360043 
…o docs-v2
@rrousselGit
Update docs to match
f67a9ab
@rrousselGit
Merge branch 'master' of https://github.com/rrousselGit/river_pod int…
d998b2d 
…o docs-v2
@rrousselGit
Update docs
f2dfa93
@rrousselGit
Add banner to notify that the current doc page might be out of date (#…
9980068 
…1747)
@rrousselGit
Remove "what package to install" section as it is covered by docs tog…
5e6adc9 
…gles
@rrousselGit
Add introduction page
d9b4665
@mansourzaki
Make docs/providers/future_provider compatible with toggles (#1752)
4ff0f74
@hamza-imran75
Fixed a typo (#1755)
5ce6c63
@JAICHANGPARK
Update copyright year text (#1760)
ea17468
@rrousselGit
Update SEO description
f0750fa
nah0y and others added 25 commits August 31, 2023 11:45
@nah0y
Update side_effects.mdx (#2868)
c0f4ac7 
Typos
@robert-virkus
Fix typo (#2916)
b0397f6
@droidbg
Fix. Broken links on .family modifier docs page (#2956)
0c28a2a 
fixes #2951
@rrousselGit
Add websocket/sync page
2ac5f71
@rrousselGit
Merge branch 'docs-v2' of https://github.com/rrousselGit/riverpod int…
74754b8 
…o docs-v2
@rrousselGit
Merge branch 'master' of https://github.com/rrousselGit/riverpod into…
abf3861 
… docs-v2
@rrousselGit
Sync generated code
83f4819
@rrousselGit
Merge branch 'master' of https://github.com/rrousselGit/riverpod into…
8f90f30 
… docs-v2
@rrousselGit
Sync riverpod version
8246a7a
@rrousselGit
Hide wip pages
2e6cdd2
@rrousselGit
Plan docs
1e26c30
@rrousselGit
Fix hash links not working
a981767
@rrousselGit
Add combining_request page
d41dc34
@rrousselGit
Add disposal page
16ba344
@rrousselGit
Restore legacy docs
d4cf33c
@rrousselGit
Ignore todos in website
fa9453d
@rrousselGit
Add eager initialization docs
93a4368
@rrousselGit
Merge branch 'master' of https://github.com/rrousselGit/riverpod into…
a8025fa 
… docs-v2
@rrousselGit
Merge branch 'master' of https://github.com/rrousselGit/riverpod into…
13b8771 
… docs-v2
@rrousselGit
Plan "show snackbar" sample
e6cfe9b
@rrousselGit
Add testing page
5eceb2b 
fixes #260
fixes #2520
@rrousselGit
Update generated code
4567a75
@rrousselGit
Downgrade test
59000f7
@rrousselGit
Add select page
07aac26
@rrousselGit
Highlight .future usage
0c550d1
@rrousselGit rrousselGit marked this pull request as ready for review October 11, 2023 13:18
@rrousselGit rrousselGit merged commit dbf47a3 into master Oct 11, 2023
43 checks passed
@rrousselGit rrousselGit deleted the docs-v2 branch October 11, 2023 13:18
@AhmedLSayed9
Copy link
Contributor

Big work! Congratulation 🎆

@TheFinestArtist
Copy link

Amazing work! Thank you for the contribution 🔥

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@rrousselGit rrousselGit

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.