Skip to content

Support :ref :cite :defn  #14

Open

Description

@lidel

Would be cool if we had built-in support for referencing specifications using high resolution references that already exist at standard bodies like W3C.

FYSA @darobin started poking at this problem space for stable referening in IPFS specs using :ref :cite and :defn.

I think what we want docs websites to support :ref :cite and :defn too – this way we can refer to specific field in spec using stable pointers, or do cross-site linking (ipfs docs linking to pubsub description in libp2p docs etc)

Activity

  1. johnnymatthews commented on Dec 12, 2022

    @johnnymatthews
    Contributor

    I've only given that repo a quick skim, but are :ref and :cite and essentially just hyperlinks? Or am I completely missing the point?

  2. added
    dif/mediumPrior experience is likely helpful
    effort/daysEstimated to take multiple days, but less than a week
    P3Low: Not priority right now
    on Dec 29, 2022
  3. moved this to 👣 Needs triage in Protocol Docson Apr 4, 2023
  4. moved this from 👣 Needs triage to 📋 Backlog in Protocol Docson Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3Low: Not priority right nowdif/mediumPrior experience is likely helpfuleffort/daysEstimated to take multiple days, but less than a week

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions