speced / speced/respec

Allow local-lt on headers

Open
#5,306 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature request
Dominant language
JavaScript
Stars
806
Forks
434
Avg merge
1d 21h
Merged PRs (30d)
32

Description

Is your feature request related to a problem? Please describe.
I have to use aliases for headers when writing about them.

Describe the solution you'd like

When I have a heading, I'd like to link to if via a local definition.

For example:

The [=API=].

For the [[The Digital Credentials API]] instead of [[The Digital Credentials API|API]].

Contributor guide

Open the contributing guide

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

No files, tests, or entry points are named. Start by locating the existing handling for local definitions and header links, then compare the current [[The Digital Credentials API|API]] form with the requested [=API=] form. Done means a local definition can resolve a header without requiring an explicit alias.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.