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

Pick a format for the spec #1

Closed
jyasskin opened this issue Aug 8, 2014 · 3 comments
Closed

Pick a format for the spec #1

jyasskin opened this issue Aug 8, 2014 · 3 comments

Comments

@jyasskin
Copy link
Member

jyasskin commented Aug 8, 2014

Right now it's in ReSpec with HTML sectioning.

  • ReSpec avoids the need to build the spec outside the browser. It has limited support for cross-spec autolinking (w3c/respec#332). It doesn't support modern WebIDL constructs like stringifier (w3c/respec#31). It generates weird sub-sections for members of dictionaries, and while there's an undocumented noLegacyStyle switch to turn them off, that simply deletes the associated documentation rather than just formatting it better (w3c/respec#334).
  • ReSpec also has an undocumented Markdown syntax (markdown option not documented w3c/respec-docs#7), which might make the document slightly easier to read.
  • https://github.com/slightlyoff/web-spec-framework is Polymer-based so also has no build step, but doesn't really provide any help with spec formatting.
  • https://github.com/tabatkins/bikeshed requires a build step, but is actually maintained and has good source-code text shortcuts and cross-spec linking.

I'm not going to investigate this in the short run, but if a clear preference emerges here, we can switch.

@marcoscaceres
Copy link
Contributor

@jyasskin we do try to actively maintain ReSpec. About the noLegacy thing ... it's half way between a feature and bug :)

Re: Bikeshed: The build step, + the somewhat weird markup variation it uses, has been an issue for contributions to the picture element. This is because people get confused as to which document to contribute to. Everything has a trade off. I would recommend ReSpec personally.

@mounirlamouri
Copy link

I second @marcoscaceres, you should probably stick with respec. It's widely used, simple and actively supported.

jyasskin referenced this issue in jyasskin/web-bluetooth-1 Dec 6, 2014
Fix bower.json syntax
@jyasskin
Copy link
Member Author

ReSpec seems to be working fine.

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

No branches or pull requests

3 participants