Conversation
SteffenDE
force-pushed
the
sd-typedoc-more-ts
branch
2 times, most recently
from
f35391c to
8717ae9
Compare
In order to make consuming and pointing to the LiveView JS documentation easier, this commit replicates the setup used in Phoenix to build and publish the JS documentation alongside the Elixir documentation in HexDocs. Because TypeScript is used in the LiveView JS codebase in the past year, use `typedoc` instead of `documentation` (which Phoenix uses for plain JS). By pointing `typedoc` directly to the `index.ts` entry point, we ensure only the public API is generated and documented. The resulting HexDocs sidebar includes a "JS Documentation" entry right after the Changelog, same as in Phoenix.
SteffenDE
force-pushed
the
sd-typedoc-more-ts
branch
from
bc19f88 to
8463b43
Compare
SteffenDE
force-pushed
the
sd-typedoc-more-ts
branch
from
8463b43 to
07e0f48
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Supersedes #4216.
Moves more code to typescript to prevent exposing temporary implementation details.