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

isPreview documentation is broken #4888

Open
npdoty opened this issue Feb 7, 2025 · 0 comments
Open

isPreview documentation is broken #4888

npdoty opened this issue Feb 7, 2025 · 0 comments
Labels

Comments

@npdoty
Copy link

npdoty commented Feb 7, 2025

Description of problem

What happened?:

https://respec.org/docs/#isPreview

Current docs say to use is Preview inside var respecify. This is invalid JavaScript, and Respec does not render.

Also, even with isPreview and inside the standard configuration object, I don't get the annoying warning to show up. And the documentation isn't clear that this is for Pull Request previews, which need additional values, and isn't just for an annoying red warning box like for an out of date or deprecated document.

Expected behavior:

Docs should describe valid JavaScript text so that Respec doesn't break, and so that the annoying red warning box is displayed with the relevant info.

@npdoty npdoty added the bug label Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant