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

Docs style guide needed #419

Open
kdb424 opened this issue Apr 24, 2022 · 4 comments
Open

Docs style guide needed #419

kdb424 opened this issue Apr 24, 2022 · 4 comments
Labels
Documentation help wanted Extra attention is needed

Comments

@kdb424
Copy link
Contributor

kdb424 commented Apr 24, 2022

If anyone has experience in creating a style guide, we would love to have one with the size we are at. If you are interested, feel free to open a PR and/or talk to us in the matrix/discord chat about it.
@kdb424 kdb424 added help wanted Extra attention is needed Documentation labels Apr 24, 2022
@rrotter
Copy link
Contributor

rrotter commented Apr 25, 2022

Maybe add a markdown linter to the ci?
markdownlint

Came here to write this comment as a separate bug, but since you got here first, idk if my suggestion is part of this bug, a duplicate, or a separate issue.

@kdb424
Copy link
Contributor Author

kdb424 commented Apr 25, 2022

Maybe I had a duplicate. Whoops. Ping me there, and I'll switch to using that if this is the primary topic.

@rrotter
Copy link
Contributor

rrotter commented Apr 25, 2022

No, you didn't do anything wrong. What I was trying to say: I was about to create a bug requesting markdown linting, but added a comment here instead.

@rrotter
Copy link
Contributor

rrotter commented Apr 25, 2022

Started on this in #420

@stefanfoulis stefanfoulis mentioned this issue Jun 5, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rrotter @kdb424