Skip to content

fix(validate): resolve 404 links in reference docs#5991

Closed
nayounsang wants to merge 2 commits intotldraw:mainfrom
nayounsang:fix-validate-docs-404
Closed

fix(validate): resolve 404 links in reference docs#5991
nayounsang wants to merge 2 commits intotldraw:mainfrom
nayounsang:fix-validate-docs-404

Conversation

@nayounsang
Copy link
Contributor

@nayounsang nayounsang commented May 1, 2025

The problem is that the type is not detected when exporting modules through the T namespace.
Therefore, in order for documentation to be automatically generated, types must be specifically exported.

(I think the same problem occurs in references of other packages, but it hasn't been reported?)

And, I have a question: Should I commit apps/docs/content/getting-started/releases-versioning.mdx and packages/validate/api-report.api.md?

close #5927

Change type

  • bugfix

Test plan

  1. Build the package
  2. Check that the links in docs validate do not result in 404.
  3. Check if a document has been created in the sidebar
  • Unit tests
  • End to end tests

Release notes

  • Export link types that exist in the document (these types are public)
  • Export by specifying the type in the index as well.

@vercel
Copy link

vercel bot commented May 1, 2025

@nayounsang is attempting to deploy a commit to the tldraw Team on Vercel.

A member of the Team first needs to authorize it.

@huppy-bot huppy-bot bot added the bugfix Bug fix label May 1, 2025
@steveruizok steveruizok requested a review from SomeHats May 2, 2025 09:31
@nayounsang
Copy link
Contributor Author

@SomeHats @TodePond Do you know how #5927 and this PR are progressing?

@steveruizok steveruizok added the sdk Affects the tldraw sdk label Jan 2, 2026
@steveruizok steveruizok changed the title fix: 404 links in validate reference docs fix(validate): resolve 404 links in reference docs Jan 2, 2026
@steveruizok
Copy link
Collaborator

Sorry @nayounsang, we're not accepting pull requests from external contributors at this time. See discussion here. If you'd like to report a bug or suggest a feature, please open an issue instead.

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

Labels

bugfix Bug fix sdk Affects the tldraw sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Some API reference links lead to 404s

3 participants