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

Feat pagination tutorial #310

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
Draft

Feat pagination tutorial #310

wants to merge 13 commits into from

Conversation

gewenyu99
Copy link
Contributor

What does this PR do?

Add pagination tutorial by @timDeHof

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

timDeHof and others added 13 commits October 4, 2023 10:20
feat(pagination): add layout, page, and markdoc files for pagination tutorial
feat(pagination): add step-1, step-2, step-3, step-4, step-5, and step-10 markdoc files
The changes include adding a new page for the pagination tutorial in the docs section. Additionally, the necessary layout, page, and markdoc files are added for each step of the pagination tutorial. This allows users to learn about pagination in a React app using the Appwrite backend. The tutorial covers topics such as setting up the project, creating a database, initializing the Appwrite SDK, and seeding the database with data.

feat(docs): add new files for pagination tutorial steps 6 and 7
The changes include the addition of two new files: `src/routes/docs/tutorials/pagination/step-6/+page.markdoc` and `src/routes/docs/tutorials/pagination/step-7/+page.markdoc`. These files contain the code and instructions for implementing pagination in a React application using Appwrite backend. The `step-6` file adds the initial code for displaying tasks using context and a custom hook, while the `step-7` file adds the implementation for offset pagination and the UI components for navigating through the dataset.

feat(docs): add tutorial pages for implementing cursor pagination and discussing trade-offs
feat(docs): add page for implementing cursor pagination in a React app using Appwrite backend
A new tutorial page has been added to the documentation that explains what cursor pagination is and how to implement it in a React app using the Appwrite backend. The page provides an overview of cursor pagination and its benefits, and includes code examples for implementing cursor pagination using Appwrite's `listDocuments()` command.

feat(docs): add page for discussing the trade-offs between offset pagination and cursor pagination
A new tutorial page has been added to the documentation that discusses the trade-offs between offset pagination and cursor pagination. The page provides a comparison table highlighting the pros and cons of each pagination method, and offers guidance on when to use each method based on different application requirements. The page also includes a recap section summarizing the key points to consider when choosing a pagination method in Appwrite.
The commit fixes capitalization and punctuation errors in the titles and descriptions of the tutorial files. This improves consistency and readability in the documentation.

docs(pagination): update tutorial pages for offset and cursor pagination methods

feat(pagination): add offset pagination method to the app
The tutorial page for implementing offset pagination is updated to provide a clear explanation of what offset pagination is and how it can be used in a React app with an Appwrite backend. The code examples and instructions are also updated to reflect the changes.

feat(pagination): add cursor pagination method to the app
The tutorial page for implementing cursor pagination is updated to provide a clear explanation of what cursor pagination is and how it can be used in a React app with an Appwrite backend. The code examples and instructions are also updated to reflect the changes.

feat(pagination): discuss trade-offs between offset and cursor pagination methods
A new tutorial page is added to discuss the trade-offs between offset and cursor pagination methods. The page provides a comparison of the two methods in terms of simplicity, performance, data consistency, scalability, implementation complexity, and direct page access. It
…eralized and focus more on pagination. Fixed title and description to use sentence case. Changed difficulty to 'intermediate' from 'beginner'. Changed readtime to '20' from '10'. Added tabsto the different methods to showcase usage of each.
…d context changes

The tutorial has been updated to include a more detailed explanation of setting up the environment configuration for the project. This includes creating a `.env` file and adding the necessary environment variables for the project, database, and collection IDs. This change makes the tutorial more beginner-friendly and ensures that users understand the importance of environment configuration in a project.

The tutorial also now includes changes to the context setup in the React application. Instead of using a single context for managing todos, two contexts are now created to manage todos for each pagination method. This change provides a clearer separation of concerns and makes the code easier to understand.

The routing section of the tutorial has been updated to reflect these changes in context setup. The App function now returns the Header component along with other components wrapped in OffsetProvider and CursorProvider components. These providers are used to provide data to the components that they wrap.

Finally, the tutorial now instructs users to create four separate files for the Todos pages. This change makes the tutorial more organized and easier to follow.
The tutorial on pagination has been updated to improve the flow and clarity of the instructions. The changes include:

- Replacing the instructions to create new files with instructions to update existing files. This change simplifies the tutorial and makes it easier to follow.
- Adding more detailed explanations of the code changes. This helps readers understand the purpose of each change and how it contributes to the overall functionality of the application.
- Removing redundant sections that were causing confusion. This makes the tutorial more concise and easier to understand.
- Updating the context to use environment variables instead of hard-coded values. This makes the code more flexible and easier to configure.

These changes were made to improve the quality of the tutorial and make it easier for readers to understand and follow.
…al-to-docs

feat(docs): add pagination tutorial and related files
Copy link

vercel bot commented Oct 31, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
website ✅ Ready (Inspect) Visit Preview Oct 31, 2023 2:31pm

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