Skip to content

UX writing principles#197

Open
Susanne254 wants to merge 19 commits intomainfrom
ux-writing-support-and-resources
Open

UX writing principles#197
Susanne254 wants to merge 19 commits intomainfrom
ux-writing-support-and-resources

Conversation

@Susanne254
Copy link
Collaborator

💡 What is the current behavior?

GitHub Issue Number: #

🆕 What is the new behavior?

👨‍💻 Help & support

@Susanne254 Susanne254 requested a review from tokyojen March 12, 2026 09:15
@netlify
Copy link

netlify bot commented Mar 12, 2026

Deploy Preview for industrial-experience ready!

Name Link
🔨 Latest commit d7aefed
🔍 Latest deploy log https://app.netlify.com/projects/industrial-experience/deploys/69b9583f6e766e0008fdf531
😎 Deploy Preview https://deploy-preview-197--industrial-experience.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces foundational documentation for UX writing principles, aimed at guiding writers in crafting effective UI text for industrial applications. It also establishes a new "Support and resources" category to logically house this and future related content within the existing documentation framework.

Highlights

  • New UX Writing Principles Documentation: A new Markdown file, "UX writing principles.md", was added to provide guidelines for creating UI text and making microcopy decisions for industrial applications.
  • Documentation Category Structure: A new "category.json" file was introduced to define a "Support and resources" category, organizing the new UX writing principles document within the documentation structure.
Changelog
  • docs/guidelines/language/support and resources/UX writing principles.md
    • Added a new document outlining UX writing principles.
  • docs/guidelines/language/support and resources/category.json
    • Created a new category definition for "Support and resources".
Activity
  • No human activity has been recorded on this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new documentation page for 'UX writing principles' and creates a 'Support and resources' category for it in the guidelines section. The changes are mostly structural, adding a placeholder markdown file and a category configuration file. My review focuses on formatting and structural correctness of the new markdown file. I've suggested removing a redundant heading, fixing a typo in the description, and adding a final newline to adhere to common best practices.

Copy link
Collaborator

@tokyojen tokyojen left a comment

Choose a reason for hiding this comment

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

I approve this page - no more changes required

Copy link
Collaborator

Choose a reason for hiding this comment

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

would be great if we could incorporate these images later on when they are working - or even just the icons - will add to V2.01 release notes

@Susanne254
Copy link
Collaborator Author

@danielleroux Please merge this content to main. Thank you very much in advance.

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.

4 participants