[CHA-188] Added typedoc to package reqs. #107
Merged
Conversation
This file contains 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
Setup basic typedoc config. Added landing page for typedoc.
splindsay-92
commented
Apr 26, 2024
| "out": "typedoc/generated", | ||
| "readme": "typedoc/landing-page.md", | ||
| "tsconfig": "tsconfig.base.json", | ||
| "treatWarningsAsErrors": false, |
There was a problem hiding this comment.
This is set to false as we have a lot of things to fix documentation-wise, but I've added all the validation in anyway so when running it locally you can just flick the switch and see what needs to be fixed.
splindsay-92
force-pushed
the
CHA-188-bootstrap-typedoc
branch
from
689e0c4 to
e98d455
Compare
AndyTWF
reviewed
Apr 29, 2024
.github/workflows/docks.yml
Outdated
| @@ -0,0 +1,42 @@ | |||
| name: API Reference | |||
There was a problem hiding this comment.
Typo in the yaml file name :)
There was a problem hiding this comment.
Sorry Andy, I think I'm being blind and can't see the issue? 🙈
There was a problem hiding this comment.
It's called docks.yml rather than docs.yml :)
There was a problem hiding this comment.
You know, I think I might have taken a year to spot that, my brain simply wouldn't see it XD
typedoc/landing-page.md
Outdated
| @@ -0,0 +1,6 @@ | |||
| # Ably Chat JavaScript Client Library SDK API Reference | |||
|
|
|||
| The JavaScript Client Library SDK supports chat functionality over ably realtime. The JavaScript API references are generated from the [Ably Chat JavaScript Client Library SDK source code](https://github.com/ably-labs/ably-chat-js) using [TypeDoc](https://typedoc.org) and structured by classes. | |||
There was a problem hiding this comment.
Suggested change
| The JavaScript Client Library SDK supports chat functionality over ably realtime. The JavaScript API references are generated from the [Ably Chat JavaScript Client Library SDK source code](https://github.com/ably-labs/ably-chat-js) using [TypeDoc](https://typedoc.org) and structured by classes. | |
| The JavaScript Client Library SDK supports chat functionality over Ably. The JavaScript API references are generated from the [Ably Chat JavaScript Client Library SDK source code](https://github.com/ably-labs/ably-chat-js) using [TypeDoc](https://typedoc.org) and structured by classes. |
|
Also - please add the JIRA ticket number to the issue title :) |
splindsay-92
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Setup basic typedoc config.
Added landing page for typedoc.
Related to infra PR here to add a required role.