Prioritise representative h-card parsing with expect=card

Open
#116 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Stale
Tech stack
php
Domain
api

Research direction

Start by reading the existing expect: feed parsing path and how it prioritises feed detection over other content types. Then check the parsing tests and identify where a card expectation can be exercised; done means expect: card prioritises representative h-card parsing when a page also contains a feed.

Written by the indexing model from the issue text.

Description

XRay currently supports passing an expect: feed parameter when parsing, to skip content type detection and prioritise feed detection and parsing. It’s common for people to publish both a representative h-card and some sort of feed on their home page, and depending on exactly how they mark it up, XRay might return either a feed or card item. When the user knows that they want a representative h-card, it would be useful to be able to pass expect: card or similar to prioritise h-card parsing over feed parsing.

Dominant language
PHP
Stars
96
Forks
17
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aaronpk/XRay

All issues in aaronpk/XRay

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.