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.

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

Update documentation styleguide #294

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update documentation styleguide #294

wants to merge 3 commits into from

Conversation

flodolo
Copy link
Contributor

@flodolo flodolo commented Jan 2, 2025

Fixes #292

@flodolo flodolo requested a review from a team as a code owner January 2, 2025 13:28
@flodolo flodolo changed the title WIP: Update document styleguides Update document styleguide Jan 2, 2025
@flodolo flodolo changed the title Update document styleguide Update documentation styleguide Jan 2, 2025
Copy link
Contributor

@Delphine Delphine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just found a nit, otherwise this seems clear to me.

src/misc/documentation_styleguide.md Outdated Show resolved Hide resolved
@flodolo flodolo requested a review from peiying2 January 4, 2025 05:46
@flodolo
Copy link
Contributor Author

flodolo commented Jan 4, 2025

@peiying2
Adding you for a pass, since you flagged the document in the first place.

@peiying2
Copy link
Contributor

peiying2 commented Jan 8, 2025

I'm good with what's already written. After reviewing the corrections in the two docs on mozilla.org that I worked on, maybe we can add these items:

  • When to use this is a highlighted text - for anything in GitHub, file/repo/folder names, etc
  • When to use this is a highlighted text - for UI strings in Pontoon or is it not as clear cut?
  • Cross reference within a doc (under Links section). A special case in bullet # 4 under the [Functionality testing](to get to the language list) section, See detailed steps below is referencing a file name, punctuation is removed and the words are strung together.

@flodolo
Copy link
Contributor Author

flodolo commented Jan 9, 2025

When to use this is a highlighted text - for anything in GitHub, file/repo/folder names, etc
When to use this is a highlighted text - for UI strings in Pontoon or is it not as clear cut?

I'm not sure about this, because we haven't been consistent in existing documents. Also, too much code formatting makes it harder, so we have been mixing that.

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.

Update Documentation style guide
3 participants