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

Create idiomatic documentation and examples #575

Open
3 tasks
mpeddada1 opened this issue Jan 2, 2025 · 2 comments
Open
3 tasks

Create idiomatic documentation and examples #575

mpeddada1 opened this issue Jan 2, 2025 · 2 comments
Assignees
@mpeddada1
Labels
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

@mpeddada1
Copy link
Collaborator

mpeddada1 commented Jan 2, 2025 •
edited by coryan
Loading

Umbrella ticket to track progress of:
@mpeddada1 mpeddada1 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 Jan 2, 2025
@mpeddada1 mpeddada1 self-assigned this Jan 2, 2025
@mpeddada1 mpeddada1 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 Jan 2, 2025
@coryan
Copy link
Contributor

coryan commented Jan 6, 2025

I am not sure if you want to include this in this bug or a separate bug. Some of the documentation links in the workflows crate are broken:

image

The problem is that google.rpc. (implemented by the gcp-sdk-rpc crate) is only included indirectly. sidekick does not know how to convert the links for indirect dependencies (see #401 to see what we do for direct dependencies).

@mpeddada1 mpeddada1 changed the title Create idiomatic documentations and examples Create idiomatic documentation and examples Jan 7, 2025
@mpeddada1 mpeddada1 mentioned this issue Jan 7, 2025
Open
@mpeddada1
Copy link
Collaborator Author

I am not sure if you want to include this in this bug or a separate bug. Some of the documentation links in the workflows crate are broken:

image

The problem is that google.rpc. (implemented by the gcp-sdk-rpc crate) is only included indirectly. sidekick does not know how to convert the links for indirect dependencies (see #401 to see what we do for direct dependencies).

Created an issue to track this. I've added it under #486 (umbrella ticket for handling issues related to doc processing and working links)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mpeddada1 mpeddada1

Labels
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
@coryan @mpeddada1