Skip to content

Generate Telemetry doc from code to make sure it's always up to date #6689

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

Open
3 tasks done
RodgeFu opened this issue Mar 26, 2025 · 1 comment
Open
3 tasks done
Labels
ide Issues for VS, VSCode, Monaco, etc.

Comments

@RodgeFu
Copy link
Contributor

RodgeFu commented Mar 26, 2025

Clear and concise description of the problem

as title.

Checklist

  • Follow our Code of Conduct
  • Read the docs.
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
@RodgeFu RodgeFu added the ide Issues for VS, VSCode, Monaco, etc. label Mar 26, 2025
@RodgeFu RodgeFu changed the title Generate Telemetry doc to make sure it's always up to date Generate Telemetry doc from code to make sure it's always up to date Mar 26, 2025
@timotheeguerin
Copy link
Member

timotheeguerin commented Mar 26, 2025

I think this would be the job of a typespec telemetry library, we shouldn't go try to generate from the typescript code.
We could do a basic emitter that generate both the TS types and markdown doc that isn't published for now

import "@typespec/telemetry";

model Foo is Telemetry.Event {   
   action: string;  
   @Telemetry.hash  
   data: string;
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ide Issues for VS, VSCode, Monaco, etc.
Projects
None yet
Development

No branches or pull requests

2 participants