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: Add doc on querying/mutating data #20

Closed
wants to merge 4 commits into from

Conversation

Pathan-Amaankhan
Copy link
Member

@Pathan-Amaankhan Pathan-Amaankhan commented Jan 30, 2025

What

  • This PR adds a doc describing how global styles and queried template data can be mutated/updated.

Related Issue(s):

Screenshots

Screenshot 2025-01-30 at 9 57 50 PM

Checklist

  • I have read the Contribution Guidelines.
  • My code is tested to the best of my abilities.
  • My code passes all lints (ESLint, tsc, prettier etc.).
  • My code has detailed inline documentation.
  • I have added unit tests to verify the code works as intended.
  • I have updated the project documentation accordingly.

@Pathan-Amaankhan Pathan-Amaankhan self-assigned this Jan 30, 2025
@Pathan-Amaankhan Pathan-Amaankhan marked this pull request as ready for review January 30, 2025 16:28
Copy link
Collaborator

@justlevine justlevine left a comment

Choose a reason for hiding this comment

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

Not entirely sure I understand this doc. Either its the wrong focus or it's missing things.

My assumption is that we should at minimum see a snippet of graphql somewhere, ideally the use of @apollo/client or even our own @snapwp/query somewhere.

Not necessary for 0.0.1, so there's time to come at this with fresh eyes.

@justlevine justlevine requested a review from SH4LIN January 30, 2025 18:08
@justlevine justlevine changed the title Docs: Adds Doc for Mutating Query Data docs: Add doc on querying/mutating data Jan 30, 2025
@justlevine justlevine added status: in progress 🚧 Work on this has begun needs: review 🧐 Needs to be reviewed by a codeowner and removed status: in progress 🚧 Work on this has begun needs: review 🧐 Needs to be reviewed by a codeowner labels Jan 30, 2025
Copy link
Collaborator

@SH4LIN SH4LIN left a comment

Choose a reason for hiding this comment

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

We should add a example code snippet which actually overrides the functions. Along with the data that is expected from those functions

@Pathan-Amaankhan
Copy link
Member Author

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.

3 participants