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: backfill next readme with getGlobalStyles() and getTemplateData() #46

Merged

Conversation

Pathan-Amaankhan
Copy link
Member

@Pathan-Amaankhan Pathan-Amaankhan commented Feb 6, 2025

What

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

Related Issue(s):

~ https://github.com/rtCamp/headless/issues/314~

Screenshots

Screenshot 2025-02-17 at 1 21 58 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 Feb 6, 2025
@Pathan-Amaankhan Pathan-Amaankhan marked this pull request as ready for review February 6, 2025 12:23
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.

#20 (review)

(It's possible the change is relocating this into one of the README.md references, but it's has nothing to do with explaining how a user can fetch custom data in their app).

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.

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.

Tl;dr from today's sync.

Move this into the respective package README.md and it can be merged.

Then we'll follow up in a separate PR with a .md on how to query wordpress data from within the WP app.

Copy link

changeset-bot bot commented Feb 17, 2025

⚠️ No Changeset found

Latest commit: 4054f59

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Pathan-Amaankhan
Copy link
Member Author

Hi @justlevine,
Have migrated the docs in e519aeb & 40fb888. Can you please re-review the PR.

@Pathan-Amaankhan Pathan-Amaankhan changed the title docs: Add doc on querying/mutating data docs: Add doc on mutating data Feb 17, 2025
@justlevine justlevine changed the title docs: Add doc on mutating data docs: backfill next readme with getGlobalStyles() and getTemplateData() Feb 17, 2025
@justlevine justlevine merged commit f78375e into rtCamp:develop Feb 18, 2025
8 checks passed
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