sourcey / sourcey/moxygen

Use dash in links?

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

Nobody has claimed this yet.

enhancement help wanted
Dominant language
TypeScript
Stars
277
Forks
94
Avg merge
8m
Merged PRs (30d)
8

Description

Using dash in internal links would make them work even without the -a option when using markdown preview of GitHub, GitLab, VS Code etc.

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

Start by locating the internal-link generation in moxygen and reviewing how its Markdown output is used in GitHub, GitLab, and VS Code previews. Done means generated internal links use dashes and work without the -a option; no file or test is named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, typescript
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.