UsingBikeshed

Installing and using bikeshed

If you can install bikeshed locally, you should do so since it makes some things more convenient. Follow the instructions for a local install.

If you can't (or it doesn't work) or just don't need a local install, you can still use the network version to generate the HTML.

Current Issues

As of commit [c3ad50], these are the errors and notes bikeshed produces when converting index.bs to index.html. When running bikeshed locally, use bikeshed -f spec to force production of the html file.

These are the current warnings and errors. You should compare your changes with this list to see if you've accidentally introduced new warnings or errors. All of the notes below are due to issues with bikeshed except for the warning about <var>s used once (see #1502) and the link error for cors-cross-origin (see #1507).

WARNING: The following <var>s were only used once in the document:
  'target gain', in algorithm 'reduction-gain'
  'attack', in algorithm 'reduction-gain'
  'nodeName', in algorithm 'process control message'
  'release', in algorithm 'reduction-gain'
  'nodeName'
  'threshold', in algorithm 'reduction-gain'
  'final gain', in algorithm 'reduction-gain'
  'ratio', in algorithm 'reduction-gain'
  'this', in algorithm 'audioworklet construction'
  'processorPortSerialization'
  'knee', in algorithm 'reduction-gain'
If these are not typos, please add an ignore='' attribute to the <var>.
WARNING: Multiple elements have the same ID 'dom-decodeerrorcallback-error'.
Deduping, but this ID may not be stable across revisions.
WARNING: Multiple elements have the same ID 'dom-decodesuccesscallback-decodeddata'.
Deduping, but this ID may not be stable across revisions.
LINE 1877: Can't find the 'contextOptions' argument of method 'OfflineAudioContext/OfflineAudioContext(numberOfChannels, length, sampleRate)' in the argumentdef block.
LINE 2870: Can't find the 'destinationNode' argument of method 'AudioNode/connect(destinationParam, output)' in the argumentdef block.
LINE 2870: Can't find the 'input' argument of method 'AudioNode/connect(destinationParam, output)' in the argumentdef block.
LINE 2971: Can't find the 'destinationNode' argument of method 'AudioNode/disconnect(destinationParam, output)' in the argumentdef block.
LINE 2981: Can't find the 'destinationNode' argument of method 'AudioNode/disconnect(destinationParam, output)' in the argumentdef block.
LINE 2996: Can't find the 'destinationNode' argument of method 'AudioNode/disconnect(destinationParam, output)' in the argumentdef block.
LINE 2996: Can't find the 'input' argument of method 'AudioNode/disconnect(destinationParam, output)' in the argumentdef block.
LINK ERROR: No 'idl-name' refs found for 'MediaStream'.
<a data-link-type="idl-name" class="n" data-lt="MediaStream">MediaStream</a>
LINK ERROR: No 'idl-name' refs found for 'MediaStreamTrack'.
<a data-link-type="idl-name" class="n" data-lt="MediaStreamTrack">MediaStreamTrack</a>
LINE 1443: No 'method' refs found for 'AudioContext()'.
LINK ERROR: No 'idl-name' refs found for 'DOMHighResTimeStamp'.
<a data-link-type="idl-name" class="n" data-lt="DOMHighResTimeStamp">DOMHighResTimeStamp</a>
LINK ERROR: No 'idl-name' refs found for 'DOMHighResTimeStamp'.
<a data-link-type="idl-name" data-lt="DOMHighResTimeStamp">DOMHighResTimeStamp</a>
LINE 1877: No 'method' refs found for 'OfflineAudioContext(contextOptions)'.
LINE 1901: No 'method' refs found for 'OfflineAudioContext(numberOfChannels, length, sampleRate)'.
LINE 2195: No 'method' refs found for 'AudioBuffer()'.
LINE 3961: No 'method' refs found for 'AnalyserNode()'.
LINE 4399: No 'method' refs found for 'AudioBufferSourceNode()'.
LINE 5663: No 'method' refs found for 'BiquadFilterNode()'.
LINE 6077: No 'method' refs found for 'ChannelMergerNode()'.
LINE 6189: No 'method' refs found for 'ChannelSplitterNode()'.
LINE 6271: No 'method' refs found for 'ConstantSourceNode()'.
LINE 6382: No 'method' refs found for 'ConvolverNode()'.
LINE 6651: No 'method' refs found for 'DelayNode()'.
LINE 6784: No 'method' refs found for 'DynamicsCompressorNode()'.
LINE 7218: No 'method' refs found for 'GainNode()'.
LINE 7325: No 'method' refs found for 'IIRFilterNode()'.
LINE 7469: No 'method' refs found for 'MediaElementAudioSourceNode()'.
LINK ERROR: No 'dfn' refs found for 'cors-cross-origin' that are marked for export.
<a data-link-type="dfn" data-lt="CORS-cross-origin">CORS-cross-origin</a>
LINE 7598: No 'method' refs found for 'MediaStreamAudioDestinationNode()'.
LINK ERROR: No 'idl-name' refs found for 'MediaStream'.
<a data-link-type="idl-name" data-lt="MediaStream">MediaStream</a>
LINE 7665: No 'method' refs found for 'MediaStreamAudioSourceNode()'.
LINE 7735: No 'method' refs found for 'MediaStreamTrackAudioSourceNode()'.
LINK ERROR: No 'idl-name' refs found for 'MediaStreamTrack'.
<a data-link-type="idl-name" data-lt="MediaStreamTrack">MediaStreamTrack</a>
LINE 7872: No 'method' refs found for 'OscillatorNode()'.
LINE 8234: No 'method' refs found for 'PannerNode()'.
LINE 8639: No 'method' refs found for 'PeriodicWave()'.
LINE 8951: No 'method' refs found for 'StereoPannerNode()'.
LINE 9079: No 'method' refs found for 'WaveShaperNode()'.
LINE 9542: No 'method' refs found for 'AudioWorkletNode()'.
LINK ERROR: No 'idl-name' refs found for 'sequence<unsigned long>'.
<a data-link-type="idl-name" data-lt="sequence&lt;unsigned long&gt;">sequence&lt;unsigned long&gt;</a>
LINK ERROR: No 'idl-name' refs found for 'record<DOMString, double>'.
<a data-link-type="idl-name" data-lt="record&lt;DOMString, double&gt;">record&lt;DOMString, double&gt;</a>
LINE 9717: No 'method' refs found for 'AudioWorkletProcessor()'.
YAY Successfully generated, but fatal errors were suppressed