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

Show type descriptions in API docs pages #6368

Open
iwahbe opened this issue Jan 8, 2025 · 0 comments
Open

Show type descriptions in API docs pages #6368

iwahbe opened this issue Jan 8, 2025 · 0 comments
Labels
area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. kind/enhancement Improvements or new features

Comments

@iwahbe
Copy link
Member

iwahbe commented Jan 8, 2025

Hello!

  • Vote on this issue by adding a 👍 reaction
  • If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

Generated API docs do not include descriptions for sub-types, though they should.]

For example, the .types.command:remote:Connection.description does not at all in the associated registry page.

Affected area/feature
@iwahbe iwahbe added area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. kind/enhancement Improvements or new features labels Jan 8, 2025
@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Jan 8, 2025
@lunaris lunaris removed the needs-triage Needs attention from the triage team label Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/api-docs Generated API docs, generated from providers. For hand-written docs, see area/docs. kind/enhancement Improvements or new features
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lunaris @iwahbe