Improve text content #17
Open
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
Long lines are hard to read (when the content are not rendered/formated) in text editors that not auto break (or not render) them.
1 - Reduce `:----` to `:--` (mininum of `-`) in tables.
2 - Use the "code" format instead the "code block" format to highlight
code spliters in text paragraphs.
1 - Add "links header" (it allows to use identifiers to refer to links).
2 - Replace no literal links by identifiers from "links header".
3 - Apply correct formatting to literal links.
4 - Fix breaked links (some characters were lost during the breaking
of the long lines).
5 - Replace the data reference to image (in lesson 3) by a web link
(get the image via GiHubRaw).
1 - Add "note panels" (specific of the Markdown from GitHub).
2 - Replace bold titles by Markdown titles.
3 - Add "code" format to Assemply keywords/instructions, numbers and similar.
4 - Replace `’`, `“` and `”` respectively by `(single quote)`, `"` and `"`.
5 - Remove some spaces from tables.
6 - Add sublist.
7 - Add blockquotes to highlight simples notes.
8 - Add content separation (`--- => <hr>`).
9 - Highlight characters that compose an Assembly keyword/instruction, when
their full name is displayed.
10 - Other tiny changes.
1 - `index.md` to `README.md`: it allows that the main content
is showed when its subdirectory is opened in GitHub.
2 - `lesson_N` to `lesson-N`: `cobol-case` is bestter than `snake_case`
to name files, because it is easier use `-` instead `_`.
3 - `image1.png` to `officedaytime-diagram.png`: an explanatory name
is every better than a generic name.
A snippet of content present in `lesson-1/README.md` also was present inside the main README. Hardly a person will start to read the lessons before to read the main README, then I decide that is not a bad idea remove it.
Yes, I forgot to update them. I add "prev lesson" too.
1 - Add changes from "pr-improve-markdown" (e6b6dfa). 2 - Summarize main titles. 3 - Improve text punctuation. 4 - Replace literal links by no literal links. 5 - Improve the use of lower case and upper case. 6 - Add more content separations (`--- => <hr>`). 7 - Remove/add some text formatting. 8 - Replace list types. 9 - Add spaces in some Assembly examples. 10 - Replace first list of the lesson 3 by a table. 11 - Other small changes.
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.
Hello again!
This is a part II of this Pull Request. I decide to divide
them because this PR, unlike the previous, is not focused in
structure changes (but it has some).
Important
Because of a human failure, this PR is late in one commit,
when compared with the other PR, but it is not a
problem (I think), already this also implement the changes.