This repository has been archived by the owner on Sep 24, 2022. It is now read-only.
Move howto from adoc to md, and drop use of table layout #108
Conversation
This file contains 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Addresses @jaredmorgs suggestion to move to markdown and adding more structure to replace that lost by the table structure.
Fixes #105 and #57.
I feel we shouldn't be recommending the use of tables to address image alignment. My reasons:
• Responsive web design principles suggest that we shouldn't assume the target screen size, and using tables locks us into a specific screen size.
• Applying layout recommendations contradicts the Google's style guide that we have decided to follow.
• TheGoodDocs templates should focus should be on content rather than style (although we might cover style elsewhere).
Note: I do think the use of tables for presenting images next to instructions is a good idea, but I think there are other ways to do it too, which should be considered as well.