Skip to content

chore: add usage docs for seo #177

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

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

ayushnirwal
Copy link
Collaborator

What

Adds documentation related to Seo systems.

Related Issue(s):

https://github.com/rtCamp/headless/issues/431

How

  • Adds example showing how to register a plugin.
  • Adds a section explaining requirements for a plugin to be registered.

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 as needed.
  • I have added a changeset for this PR using npm run changeset.

Signed-off-by: ayushnirwal <[email protected]>
@ayushnirwal ayushnirwal requested review from justlevine and SH4LIN May 12, 2025 11:16
@ayushnirwal ayushnirwal self-assigned this May 12, 2025
Copy link

changeset-bot bot commented May 12, 2025

⚠️ No Changeset found

Latest commit: 8167546

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

@coveralls
Copy link

coveralls commented May 12, 2025

Pull Request Test Coverage Report for Build 15050720227

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 60.354%

Totals Coverage Status
Change from base Build 15050382275: 0.0%
Covered Lines: 507
Relevant Lines: 743

💛 - Coveralls

Comment on lines +52 to +54
- **Fragment** to define the data needed from the WP server.
- **Parser** to parse the fragment data to be consumable by NextJS.
- **Location** has value of either `page` or `layout`. This defines if the parsed meta data should be added to the returned value of `getPageMetadata` or `getLayoutMetadata`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we should provide the actual shape, if not an example of these. See the level of fidelity in query-engine.md

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.

A bit more on what needs to be provided to registerPlugin, and we should be good to merge.

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