[docs][snack-sdk] typedoc outputs malformed docs
Open
Nobody has claimed this yet.
bug
documentation
snack-sdk
- Dominant language
- TypeScript
- Stars
- 508
- Forks
- 178
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 5
Description
Summary
the yarn doc command inside of packages/snack-sdk outputs just the README file and all the links will be broken. Exiting docs have the readme + classes folder + interfaces folder.
What platform(s) does this occur on?
Dev environment (maybe CI as well)
How to reproduce
Run yarn doc on main, check the docs/snack-SDK-api folder
Link to the related docs page
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Run yarn doc from packages/snack-sdk and inspect docs/snack-SDK-api. Compare the generated output with the expected README, classes, and interfaces folders, then trace the Typedoc configuration or entry point used by the command. Done means the generated docs include those sections and their links work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100