indieweb / indieweb/microsub

Change Description and Recommended Behavior of Search Action

Open
#49 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
23
Forks
1
PR merge metrics
No merged PRs in 30d

Description

https://indieweb.org/Microsub-spec#Search

As discussed at https://indieweb.org/2021/Pop-ups/Microsub, this would be a shift from the paradigm of following feeds to following people.

* Search parameter should be explained that it does not need to be a feed URL. It could be a name looked up in a contact list, for example, or any other discovery methodology.
* We could instead focus on entering h-card url the endpoint could figure out how to derive feeds from h-card in order to emphasize the following of people.
* The endpoint could be more opinionated and return the feed it thinks best represents the identity, as opposed to all possibly found feeds. There may need to be separate discussion outside the spec re how to best find this feed.

This also has implications on the client side, where currently, most clients are letting users choose from multiple options.

Spec should recommend clients display the author property of the feed over the URL.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the Microsub-spec Search section and the linked 2021 Pop-ups/Microsub discussion. Resolve the proposed search and feed-selection behavior before updating the specification, including the client recommendation to display a feed's author rather than its URL; done means the revised behavior is documented consistently.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.