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

refactor(docs): rewrite docs to be tsdoc based #2111

Open
dansaadati opened this issue Dec 6, 2022 · 2 comments
Open

refactor(docs): rewrite docs to be tsdoc based #2111

dansaadati opened this issue Dec 6, 2022 · 2 comments
Assignees
@dansaadati
Labels
api: storage Issues related to the googleapis/nodejs-storage API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@dansaadati
Copy link

We're seeing missing links and other issues on docs hosted at https://cloud.google.com/nodejs/docs/reference/storage/latest. We should rewrite docs to be tsdoc based, which is compatible with Cloud RAD. From there, we can evaluate what other issues should be addressed.
@dansaadati dansaadati added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. priority: p3 Desirable enhancement or fix. May not be included in next release. labels Dec 6, 2022
@product-auto-label product-auto-label bot added the api: storage Issues related to the googleapis/nodejs-storage API. label Dec 6, 2022
@dansaadati dansaadati added priority: p2 Moderately-important priority. Fix may not be included in next release. and removed priority: p3 Desirable enhancement or fix. May not be included in next release. labels Dec 6, 2022
@dansaadati dansaadati self-assigned this Dec 6, 2022
@ddelgrosso1
Copy link
Contributor

@dansaadati is this still planned to be rewritten?

@dansaadati
Copy link
Author

We're seeing missing links and other issues on docs hosted at https://cloud.google.com/nodejs/docs/reference/storage/latest. We should rewrite docs to be tsdoc based, which is compatible with Cloud RAD. From there, we can evaluate what other issues should be addressed.

Yes, we've been doing work with our Cloud RAD Node.js generator to address bugs/improve quality. Once that looks better, we'll rewrite docs to be TSDoc-based.

@ddelgrosso1 ddelgrosso1 mentioned this issue Jun 12, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dansaadati dansaadati

Labels
api: storage Issues related to the googleapis/nodejs-storage API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dansaadati @ddelgrosso1