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

Sort out docs errors #855

Open
josephjclark opened this issue Dec 4, 2024 · 0 comments
Open

Sort out docs errors #855

josephjclark opened this issue Dec 4, 2024 · 0 comments

Comments

@josephjclark
Copy link
Collaborator

josephjclark commented Dec 4, 2024

When the docs build runs, it'll report a bunch of errors and warnings.

These are ignored by the CI build - but probably it's about time we forced the build to fail and make us get on and fix the problems.

We can only do this when we've validated that any errors currently being thrown are valid - I think there's a lot of out of date stuff in the validator which need addressing.

We also need to add a warning for embedding an {@link} tag in an example caption, which causes problems (in the doc site and lightning). See #856

See also #684 #525

I think we should also absorb simple-ast as part of this work, see #13

@github-project-automation github-project-automation bot moved this to New Issues in v2 Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: New Issues
Development

No branches or pull requests

1 participant