Contributing and Style Guide

important

We're in the middle of some fast-moving changes to the Forem Admin experience, so we've paused documentation updates for the time being. You may find that the docs are now outdated in parts. If you have any questions, please visit forem.dev to request additional support. We thank you for your patience and hope you're liking the changes!

Thanks for your interest in contributing to Forem's Admin Documentation!  Before getting started, we'd like you to review our contributing and style guide. Afterward, please visit our Forem Admin Docs repo and submit an issue using one of our templates.

Naming Conventions

When naming files we should opt for kebab case, kebab-case, in order to remain consistent and clear. This rule applies for folders as well. However, before creating a folder, it'd be best to check in with the Community Success team at  forem.dev for organizational purposes.

Examples

Document Title: User Roles > user-roles.md

Document Title: Pages > pages.md

Document Title: Connecting with Forem Creators and Admins  >
connecting-with-forem-creators-and-admins.md

With a longer title, it'd also be acceptable to shorted the slug(or file name). For example we could shorten the name to: connect-forem-creators.md

File Extension

We'll always be using the markdown, .md, extension - see Examples above.