Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation missing links to cross-package sources #532

Closed
donmccurdy opened this issue Mar 25, 2022 · 1 comment · Fixed by #940
Closed

Documentation missing links to cross-package sources #532

donmccurdy opened this issue Mar 25, 2022 · 1 comment · Fixed by #940
Labels
bug Something isn't working documentation
Milestone
Website v2

Comments

@donmccurdy
Copy link
Owner

donmccurdy commented Mar 25, 2022 •
edited
Loading

Describe the bug

API documentation for @gltf-transform/extensions is missing source links to implementations coming from the @gltf-transform/core package.

To Reproduce

  1. Visit https://gltf-transform.donmccurdy.com/classes/extensions.materialsvariants.html#isRequired

  2. Scroll to dispose or isRequired definitions

  3. Note they have broken source links like

    Defined in glTF-Transform/packages/core/dist/extension.d.ts:67

Expected behavior

Source links should be correct and clickable.

Additional context
@donmccurdy donmccurdy added bug Something isn't working documentation labels Mar 25, 2022
@donmccurdy donmccurdy added this to the Backlog milestone Mar 25, 2022
@donmccurdy donmccurdy changed the title Documentation has broken links to cross-package sources Documentation missing links to cross-package sources Apr 20, 2022
@donmccurdy donmccurdy mentioned this issue Nov 23, 2022
Closed
@donmccurdy donmccurdy mentioned this issue May 8, 2023
Open
7 tasks
@donmccurdy donmccurdy modified the milestones: Backlog, Website v2 May 9, 2023
@donmccurdy donmccurdy mentioned this issue May 16, 2023
Merged
8 tasks
@donmccurdy
Copy link
Owner Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation
Projects
None yet
Milestone
Website v2
Development

Successfully merging a pull request may close this issue.

Documentation: Add GreenDoc, remove TypeDoc donmccurdy/glTF-Transform
1 participant
@donmccurdy