palantir / palantir/documentalist

Inline typedoc tags like {@link}?

Open
#117 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
160
Forks
32
Avg merge
1h 40m
Merged PRs (30d)
141

Description

How would I add inline typedoc tags such as {@link}?

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

The issue names no files, tests, or entry points. Review the TypeScript documentation-generation flow and existing TypeDoc support first, then clarify the expected behavior for inline tags such as {@link} before defining what completion and verification would require.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.