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

Automatic typescript checking of code in documentation #7448

Open
AlexanderZeilmann opened this issue Nov 25, 2024 · 1 comment · Fixed by #7491
Open

Automatic typescript checking of code in documentation #7448

AlexanderZeilmann opened this issue Nov 25, 2024 · 1 comment · Fixed by #7491
Assignees
Labels
Component: Documentation Issue or pull request is related to Documentation Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible

Comments

@AlexanderZeilmann
Copy link
Contributor

Describe the bug

I already brought this up a while ago, that an (semi)-automated checking of the typescript code in the documentation is feasible.

Before working on this, I just wanted to ask how you would prefer a pull request? One big PR with everything? One PR per component? One PR per problem type? Easiest for me is probably one per component.

There are various kinds of errors that can be found. The most common ones are type error and import issues:

Type errors like:

Import issues like:

In the long run it might make sense to store the code examples in the docs as separate files (that can be type checked & linted more easily) instead of storing the code in strings.

Reproducer

No response

System Information

not applicable

Steps to reproduce the behavior

No response

Expected behavior

No response

@AlexanderZeilmann AlexanderZeilmann added the Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible label Nov 25, 2024
@melloware
Copy link
Member

One per component would probably be easiest to code review?

@melloware melloware added Component: Documentation Issue or pull request is related to Documentation and removed Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible labels Nov 25, 2024
@melloware melloware reopened this Dec 10, 2024
@github-actions github-actions bot added the Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Issue or pull request is related to Documentation Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible
2 participants