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 ModelList import path #24

Closed
wants to merge 1 commit into from
Closed

Conversation

kovsu
Copy link
Contributor

@kovsu kovsu commented Mar 20, 2025

Description

The @rstore/vue package doesn't export type ModelList. It's from @rstore/shared.

Additional context


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • If it's a new feature, provide a convincing reason to add it. Ideally, you should open a suggestion issue first and have it approved before working on it.
  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the Commit Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Hello @kovsu, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request updates the import path for ModelList in the documentation. The @rstore/vue package does not export this type, so the import is changed to @rstore/shared where it is actually defined. This change affects two files in the docs/guide directory.

Highlights

  • Documentation Update: The import path for ModelList is corrected in the documentation to reflect its actual source in @rstore/shared.
  • Incorrect Import: The original import path @rstore/vue was incorrect as ModelList is not exported from that package.

Changelog

  • docs/guide/getting-started.md
    • Updated import path for ModelList from @rstore/vue to @rstore/shared.
  • docs/guide/model/model.md
    • Updated import path for ModelList from @rstore/vue to @rstore/shared.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


Trivia time!

What is TypeScript, and what problem does it solve?

Click here for the answer
TypeScript is a superset of JavaScript that adds static typing. It helps catch errors during development, improves code readability, and enables better tooling support.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

The pull request updates the import path for ModelList from @rstore/vue to @rstore/shared in the documentation. This change aligns the documentation with the correct location of the type definition. The changes are straightforward and address a clear issue.

Merge Readiness

The pull request is ready for merging. The changes are straightforward and correct the import path for ModelList in the documentation. I am unable to directly approve the pull request, and recommend that others review and approve this code before merging.

Copy link

pkg-pr-new bot commented Mar 20, 2025

Open in Stackblitz

@rstore/core

npm i https://pkg.pr.new/directus/rstore/@rstore/core@24

@rstore/nuxt

npm i https://pkg.pr.new/directus/rstore/@rstore/nuxt@24

@rstore/nuxt-drizzle

npm i https://pkg.pr.new/directus/rstore/@rstore/nuxt-drizzle@24

@rstore/nuxt-directus

npm i https://pkg.pr.new/directus/rstore/@rstore/nuxt-directus@24

@rstore/shared

npm i https://pkg.pr.new/directus/rstore/@rstore/shared@24

@rstore/vue

npm i https://pkg.pr.new/directus/rstore/@rstore/vue@24

commit: 47406d6

@Akryum
Copy link
Collaborator

Akryum commented Mar 20, 2025

Hello! Thank you for your PR! The type is exported in the @rstore/vue package since 0.5.6

@Akryum Akryum closed this Mar 20, 2025
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