Fix #1036 - Attempt to convert the spec to bikeshed #1039
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
This is for now
Solving the issues little by little. |
The first pass is done. Yoohoo! BIKESHED: Bikeshed Documentation https://speced.github.io/bikeshed/ Command for compiling the spec: bikeshed spec Overview.bs You need a local install as it is composed of multiple files. SPEC ORGANIZATION: Overview.bs is linking to markdown version of the different chapters. The HTML version files are kept in the repo for now to make sure, information has not been lost until the confidence is high enough that we can remove them. In the future, Tab Atkins will make it possible to generate a multipage version of the spec. All chapters follow the previous organization except toward the appendices. WORK TO BE DONE: Some questions and TODO: * TODO: Fix references. Successfully generated, with 3389 linking errors * TODO: Some of the summary for elements were done automagically. We need to double check this. Search @@ in the prose. * TODO: Check that all images are correctly integrated * TODO: Check that all markup examples are correctly inserted * TODO: Rewrite step by step the paragraph so that they are more bikeshedy * QUESTION: Bikeshed handles a lot of the references building, maybe we can get rid of them in the prose as they will be automatically added. See TODO below. * TODO: Check if the IDL references is similar to the previous one * TODO: Check if the element index is correct * TODO: Check if the attribute index is correct * TODO: Check if the property index is correct * TODO: Check if the references index is correct
karlcow
force-pushed
the
1036-bikeshed-version
branch
from
5d302d9 to
edc36c6
Compare
Member
Author
|
The first pass is done. Yoohoo! BIKESHED: Command for compiling the spec: You need a local install as it is composed of multiple SPEC ORGANIZATION: In the future, Tab Atkins will make it possible to All chapters follow the previous organization WORK TO BE DONE: (moved in the description above) |
Member
Author
|
As this is my first time dealing with bikeshed, I'm happy for any recommendations on how to properly handle this TODO list. |
This finishes the conversion of the introduction file of SVG. intro.md to bikeshed. It adds at other places the necessary markup to make the intro document working and fix some references with the same patterns Next step is conform.md for the Conformance Criteria section.
* Fixing the markup * Fixing links in other sections when necessary * Some links/sections are marked with @@fix when I could not find the right way to link to them * Removed the out of sight for mathml * added a better style for example table of SVG smiley. * Fixed the table of SVG smiley which lacked a category * still 3177 links to fix * fixed to more modern versions of HTTP/1.1
* Fixing links and markups * Fixing links have a tendency to improve links in others area * created two Text Macro added to Overview.bs RENDERABLE for renderable elements NEVERRENDERED for non-renderable elements
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An attempt at converting SVG2 to bikeshed.
.mdfiles and remove doctypes<edit:<CDATAsections, replace them by<xmp>@@when they are things to check later.@@in the prose.<wpt></wpt>references in each appropriate sections