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.

Sign up for GitHub

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

Jump to bottom

Markdown consistency #87

Closed
ninelore opened this issue Oct 15, 2023 · 8 comments
Closed

Markdown consistency #87

ninelore opened this issue Oct 15, 2023 · 8 comments

Comments

@ninelore
Copy link
Member

While Markdown is very forgiving with bad formatting, we should bring the docs to a common markdown formatting standard.

Selection of issues:

  • Both too many and no blank lines. There should be only one empty line between elements
  • Heading order: # -> ## - > ### -> ####; No ****' as headers
  • Trailing spaces
  • Inconsistent horizontal line - count (common is x3)
  • ...
@meghan06
Copy link
Member

meghan06 commented Oct 15, 2023 •
edited
Loading

For anybody contributing to the docs,

  • Title pages should be ##, and each section in a page should be ###. : See below comment
  • If making a new page, the name of it should be short and concise, preferably 2 words or less.
  • ...

@meghan06 meghan06 pinned this issue Oct 15, 2023
@ninelore
Copy link
Member Author

Page Title must be # or its another markdown violation

Heading order: # -> ## - > ### -> ####; No ****' as headers

@WeirdTreeThing
Copy link
Member

Should this info be put in the README or a separate page for contributing info?

@ninelore
Copy link
Member Author

We will put it in contributing once initial fixes are complete

sadlerm4 added a commit to sadlerm4/docs that referenced this issue Nov 10, 2023
@sadlerm4
Edit markdown formatting and page layout for consistency, clean up tr…
b6e26df 
…ailing spaces and unnecessary blank lines in code to address chrultrabook#87

Replace some horizontal lines with breaks for a better reading experience
Fix non-sequential numbering
Make title block on each page more uniform with consideration to adding relevant terminology for that page directly underneath the title (see open WIP checklist chrultrabook#62)

Move install directions for Chrultrabook Controller to post-install.md
Remove old information regarding running Windows on RW_LEGACY if using Ryzen
Remove accidental "reboot" instruction on purchasing-drivers.md
...and other various minor fixes
@sadlerm4 sadlerm4 mentioned this issue Nov 12, 2023
Closed
ethanaobrien pushed a commit to ethanaobrien/docz that referenced this issue Nov 13, 2023
@sadlerm4 @ethanaobrien
Edit markdown formatting and page layout for consistency, clean up tr…
a1f8c64 
…ailing spaces and unnecessary blank lines in code to address chrultrabook#87

Replace some horizontal lines with breaks for a better reading experience
Fix non-sequential numbering
Make title block on each page more uniform with consideration to adding relevant terminology for that page directly underneath the title (see open WIP checklist chrultrabook#62)

Move install directions for Chrultrabook Controller to post-install.md
Remove old information regarding running Windows on RW_LEGACY if using Ryzen
Remove accidental "reboot" instruction on purchasing-drivers.md
...and other various minor fixes
ethanaobrien pushed a commit that referenced this issue Nov 18, 2023
@sadlerm4 @ethanaobrien
Edit markdown formatting and page layout for consistency, clean up tr…
33d5b63 
…ailing spaces and unnecessary blank lines in code to address #87

Replace some horizontal lines with breaks for a better reading experience
Fix non-sequential numbering
Make title block on each page more uniform with consideration to adding relevant terminology for that page directly underneath the title (see open WIP checklist #62)

Move install directions for Chrultrabook Controller to post-install.md
Remove old information regarding running Windows on RW_LEGACY if using Ryzen
Remove accidental "reboot" instruction on purchasing-drivers.md
...and other various minor fixes
@ethanaobrien
Copy link
Contributor

Can this be closed

@ninelore
Copy link
Member Author

ninelore commented Nov 28, 2023 •
edited
Loading

nope, my markdown linter still screams at me

https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint

@ninelore
Copy link
Member Author

#152 is related

@ninelore ninelore mentioned this issue Apr 16, 2024
Merged
ninelore added a commit that referenced this issue Jun 23, 2024
@ninelore
markdownlint workflow
48eb96d 
Addresses #87
@ninelore ninelore mentioned this issue Jun 23, 2024
Merged
@ninelore
Copy link
Member Author

ninelore commented Jul 11, 2024 •
edited
Loading

fixed in #191, #174

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@ninelore @WeirdTreeThing @meghan06 @ethanaobrien