Skip to content

docs: fix references with @link and validate via CI#868

Open
oeninghe-dataport wants to merge 1 commit into
nextfrom
fix/671-typedoc-resolution
Open

docs: fix references with @link and validate via CI#868
oeninghe-dataport wants to merge 1 commit into
nextfrom
fix/671-typedoc-resolution

Conversation

@oeninghe-dataport

Copy link
Copy Markdown
Collaborator

Summary

  • All @link references are fixed.
  • Typedoc-conformity is now validated via CI.
  • The ESLint rule tsdoc/syntax is disabled (replaced by typedoc-validation).

Instructions for local reproduction and review

  • Pipeline succeeds.
  • View the documentation.

Relevant tickets, issues, et cetera

Fixes #671

@oeninghe-dataport oeninghe-dataport added this to the POLAR@3 milestone Jul 7, 2026
@oeninghe-dataport oeninghe-dataport self-assigned this Jul 7, 2026
@oeninghe-dataport oeninghe-dataport requested a review from a team July 7, 2026 11:31
@oeninghe-dataport oeninghe-dataport added bug Something isn't working documentation Improvements or additions to documentation labels Jul 7, 2026
@oeninghe-dataport oeninghe-dataport added the testing Pertaining to tests label Jul 7, 2026
@oeninghe-dataport oeninghe-dataport added the github_actions Pull requests that update GitHub Actions code label Jul 7, 2026
@oeninghe-dataport oeninghe-dataport force-pushed the fix/671-typedoc-resolution branch from bb74614 to 7b6429e Compare July 7, 2026 11:42
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://Dataport.github.io/polar/pr-preview/pr-868/

Built to branch gh-pages at 2026-07-07 11:44 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@dopenguin dopenguin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • I certainly dislike that I now can write invalid TSDoc and I either have to enable husky or wait on the pipeline to succeed.
  • I am no longer able to click on the rendered TSDoc in the IDE and directly read the linked function / parameter, example below
    Image
    Image

🏓 @oeninghe-dataport

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation github_actions Pull requests that update GitHub Actions code testing Pertaining to tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Linking to other types in TSDoc can not be resolved when building the documentation

2 participants