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

Style Guide #4741

Open
cielf opened this issue Oct 27, 2024 · 5 comments · May be fixed by #4824
Open

Style Guide #4741

cielf opened this issue Oct 27, 2024 · 5 comments · May be fixed by #4824
Assignees
@cielf

Comments

@cielf
Copy link
Collaborator

cielf commented Oct 27, 2024

Summary

Create a style guide

Why?

Consistency. Save time on review of current materials

Details

It doesn't have to be extensive, but it would cover things like:

  • Spelling (American in the app and documentation)
  • Capitalization rules (I suggest Title Case for all headings, labels, and buttons.)
  • Rules for sorting (lower case alphabetical)
  • colours , or some equivalence -- like what the css classes are for warnings and the like

Ultimately, we might like to have this "live" -- in that we can show actual examples -- that is, it would be an erb.

Linked to from Contributing.md

Thoughts?
@cielf cielf self-assigned this Oct 27, 2024
@jimmyli97
Copy link
Contributor

jimmyli97 commented Oct 28, 2024 •
edited
Loading

It's probably out of date but the wiki has one from 2018

@cielf
Copy link
Collaborator Author

cielf commented Oct 28, 2024

Thank you -- that'll be a good start.

@github-actions GitHub Actions
Copy link
Contributor

This issue is marked as stale due to no activity within 30 days. If no further activity is detected within 7 days, it will be unassigned.

@github-actions github-actions bot added the stale label Nov 28, 2024
@cielf
Copy link
Collaborator Author

cielf commented Nov 28, 2024

Still on my plate

@cielf cielf removed the stale label Nov 28, 2024
@cielf
Copy link
Collaborator Author

cielf commented Dec 3, 2024

Limiting this to a style guide for the user documentation. The style guide from the wiki above deals with the app itself.

@cielf cielf linked a pull request Dec 3, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cielf cielf

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Minor tweaks to the style guide for the user manuals cielf/human-essentials
2 participants
@jimmyli97 @cielf