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.

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

[cosmos] Update dev dependency "typedoc" #9327

Closed
wants to merge 3 commits into from

Conversation

mikeharder
Copy link
Member

Script npm run docs completes without error, but I'm not sure if the doc content needs to be verified as well.

D:\Git\js-mh\sdk\cosmosdb\cosmos>npm run docs

> @azure/[email protected] docs D:\Git\js-mh\sdk\cosmosdb\cosmos
> typedoc --excludePrivate --mode file --out ./dist/docs ./src


Using TypeScript 3.9.3 from D:\Git\js-mh\common\temp\node_modules\.pnpm\registry.npmjs.org\typescript\3.9.3\node_modules\typescript\lib
Rendering [========================================] 100%

Documentation generated at D:\Git\js-mh\sdk\cosmosdb\cosmos\dist\docs

Also, this is the only package in the repo which has a dev dependency on typedoc. Docs for other packages are generated via a dedicated pipeline and tool which depends on typedoc:

https://github.com/Azure/azure-sdk-for-js/tree/de8499ebef11d32836dc652bd1ef6e71323d1bc8/eng/tools/generate-doc
https://github.com/Azure/azure-sdk-for-js/blob/de8499ebef11d32836dc652bd1ef6e71323d1bc8/eng/pipelines/docs.yml

Does cosmos use this doc pipeline yet? If so, maybe the typedoc dev dependency could be removed?

CC: @KarishmaGhiya, @willmtemple

@mikeharder mikeharder added EngSys This issue is impacting the engineering system. Client This issue points to a problem in the data-plane of the library. Cosmos labels Jun 5, 2020
@mikeharder mikeharder marked this pull request as draft June 5, 2020 04:01
@mikeharder mikeharder closed this Jun 5, 2020
@mikeharder mikeharder reopened this Jun 5, 2020
@mikeharder mikeharder closed this Jun 5, 2020
@mikeharder mikeharder reopened this Jun 5, 2020
@mikeharder
Copy link
Member Author

Closing since the JS team is owning dependency updates going forward. CC: @ramya-rao-a

@mikeharder mikeharder closed this Oct 29, 2020
@mikeharder mikeharder deleted the cosmos-typedoc branch February 17, 2023 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client This issue points to a problem in the data-plane of the library. Cosmos EngSys This issue is impacting the engineering system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants