Skip to content

Conversation

@chmst
Copy link
Contributor

@chmst chmst commented Aug 16, 2022

…link to coding standards and code style

@chmst chmst requested a review from drmenzelit August 16, 2022 07:45
@brianteeman
Copy link
Contributor

agreed

personaly I would put this link with the other 4 main blocks

and replace it (if necessary) to a page that is a style guide for writing documentation

@chmst
Copy link
Contributor Author

chmst commented Aug 16, 2022

style guide for writing documentation

work in progress @crystalenka

@crystalenka
Copy link
Member

Just leaving this here so I can find it again; these are a couple light guiding principles that I'm starting with.

  1. Refer to people as people, humans, etc—not users.
  2. Write in active voice. (For example: "You can make a button by..." instead of "buttons are created by...")
  3. Don't Repeat Yourself. Link to other docs instead of explaining the same thing twice.
  4. Person-first language unless a community in general has expressed a different preference. (For example, "people with ADHD" vs "Autistic individuals")

@HLeithner
Copy link
Member

just for info the footer gets replaced by the joomla cdn footer and is not part of the documentation.

@HLeithner HLeithner merged commit 550761c into main Aug 16, 2022
@HLeithner HLeithner deleted the rename-menuitem-styleguide branch August 27, 2022 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants