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

Can't generate html file for bikeshed file #11233

Closed
gitspeaks opened this issue Nov 18, 2024 · 8 comments · Fixed by #11240
Closed

Can't generate html file for bikeshed file #11233

gitspeaks opened this issue Nov 18, 2024 · 8 comments · Fixed by #11240
Labels

Comments

@gitspeaks
Copy link

I would like to submit edits to the spec via a pull request, but I am unable to generate a preview HTML file to verify my changes.

I attempted to preview the spec using https://api.csswg.org/bikeshed/ by submitting a direct link to the Bikeshed file:
https://github.com/gitspeaks/csswg-drafts/blob/main/css-position-3/Overview.bs.

However, I see the following errors:

FATAL ERROR: The document requires at least one <pre class=metadata> block.
FATAL ERROR: Spurious / in <input>.
FATAL ERROR: Found unmatched text macro [ABSTRACT]. Correct the macro, or escape it by replacing the opening [ with [

I cloned the repository locally and switched to the main branch. In the css-position-3 directory, I ran:

bikeshed spec Overview.bs

But I get this error:

LINE ~398: Couldn't find section '#inset-area' in spec 'css-anchor-position-1':
[[css-anchor-position-1#inset-area]]
✘  Did not generate, due to errors exceeding the allowed error level.

My Environment:

Bikeshed version: 4.2.7
Spec branch: main
Spec directory: css-position-3/Overview.bs

Could you please help me understand what might be causing these errors and how I can resolve them?

@Loirooriol
Copy link
Contributor

The errors should be fixed, but you can use bikeshed -f spec Overview.bs as described in https://speced.github.io/bikeshed/#cli-options

@Loirooriol
Copy link
Contributor

Could you please help me understand what might be causing these errors

The error is because of this broken link:

See [[css-anchor-position-1#inset-area]].

You can see it broken in https://drafts.csswg.org/css-position/#original-cb

It broke in #10592 @nt1m

@gitspeaks
Copy link
Author

The most recent commit I see is:

[web-animations-2] Change progress to overallProgress (#11184)

Could you confirm if the fix has been merged into the main branch?

@Loirooriol
Copy link
Contributor

With "should be fixed" I mean that somebody should fix it rather than relying of -f, not that it has been done already.

@Loirooriol
Copy link
Contributor

In other words, if you were already planning to send some patches to the spec, this can be a good first bug

@gitspeaks
Copy link
Author

With "should be fixed" I mean that somebody should fix it rather than relying of -f, not that it has been done already.
In other words, if you were already planning to send some patches to the spec, this can be a good first bug

Understood. I currently have an edit on a different issue that I'd like to submit. Could you please review it to ensure I've followed the process correctly?

@gitspeaks
Copy link
Author

Created PR #11239. Not sure about the error check message

@gitspeaks
Copy link
Author

Can confirm that running csswg-drafts/css-position-3$ bikeshed spec Overview.bs results in the message:

✔ Successfully generated, with 146 linking errors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants