Skip to content

docs: new UX writing branch web language#187

Open
tokyojen wants to merge 28 commits intomainfrom
web_application_lang_ux_writing
Open

docs: new UX writing branch web language#187
tokyojen wants to merge 28 commits intomainfrom
web_application_lang_ux_writing

Conversation

@tokyojen
Copy link
Collaborator

@tokyojen tokyojen commented Mar 2, 2026

Ready for markdown - susanne and Zsuz

💡 What is the current behavior?

GitHub Issue Number: #

🆕 What is the new behavior?

👨‍💻 Help & support

Ready for markdown - susanne and Zsuz
@tokyojen tokyojen requested a review from Susanne254 March 2, 2026 08:22
@netlify
Copy link

netlify bot commented Mar 2, 2026

Deploy Preview for industrial-experience ready!

Name Link
🔨 Latest commit 9848111
🔍 Latest deploy log https://app.netlify.com/projects/industrial-experience/deploys/69b9488fd334ae000861daa1
😎 Deploy Preview https://deploy-preview-187--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 expands the documentation for UX writing guidelines by introducing a new section dedicated to 'Web and application language.' It includes several new placeholder pages for topics like error pages, linking resources, onboarding, and 'what's new' dialogs, along with reordering existing documentation to integrate this new content seamlessly into the sidebar navigation.

Highlights

  • New Documentation Category: Introduced a new documentation category named 'Web and application language' to organize specific UX writing guidelines.
  • New Placeholder Pages: Added several new placeholder Markdown files under the 'Web and application language' category for topics such as error pages, linking resources, onboarding, and 'what's new' dialogs.
  • Sidebar Position Adjustments: Adjusted the sidebar positions of existing language guideline documents to accommodate the new category and its content, ensuring proper ordering in the documentation navigation.
Changelog
  • docs/guidelines/language/dialogs-and-buttons.md
    • Updated sidebar position from 11 to 10.
  • docs/guidelines/language/formatting/category.json
    • Updated category position from 5 to 7.
  • docs/guidelines/language/frequent-app-functions.md
    • Updated sidebar position from 8 to 9.
  • docs/guidelines/language/main-menu-functions.md
    • Updated sidebar position from 7 to 8.
  • docs/guidelines/language/web-and-application-language/category.json
    • Added new category definition for 'Web and application language' at position 6.
  • docs/guidelines/language/web-and-application-language/error-pages.md
    • Added a new starter page for error page language guidance.
  • docs/guidelines/language/web-and-application-language/linking-resources.md
    • Added a new starter page for linking resources language guidance.
  • docs/guidelines/language/web-and-application-language/onboarding.md
    • Added a new starter page for onboarding language guidance.
  • docs/guidelines/language/web-and-application-language/whats-new-dialogs.md
    • Added a new starter page for 'What's new dialogs' language guidance.
Activity
  • No human activity (comments, reviews, or progress updates) has been recorded for 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.

@tokyojen
Copy link
Collaborator Author

tokyojen commented Mar 2, 2026

This is just the branch creation with the correct naming and positioning. Now ready for team to start markdown.

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 adds new placeholder documentation pages for 'Web and application language' and adjusts the sidebar positions of existing pages. My review found a few minor structural issues in the new files. The new JSON category file should have a final newline for consistency. The new markdown pages contain an empty H1 heading, which goes against the documentation style guide that states the initial description should not have a headline. I've provided suggestions to correct these issues.

Susanne254
Susanne254 previously approved these changes Mar 3, 2026
Copy link
Collaborator

@kathrinschalber kathrinschalber left a comment

Choose a reason for hiding this comment

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

  • A few minor formatting things
  • Feedback regarding duplicate content from already existing chapters (where we should at least cross-link)
  • Regarding the structure, you might want to reconsider the folder names - it's difficult to know what UI Wording is (since everything we do describes UI copy)
  • The new UI Wording section is missing in the UX Writing overview

Copy link
Collaborator

@kathrinschalber kathrinschalber left a comment

Choose a reason for hiding this comment

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

only got a tiny little finding I've missed in my first review. Rest is good to go :)

@kathrinschalber kathrinschalber self-requested a review March 17, 2026 12:36
@tokyojen
Copy link
Collaborator Author

@danielleroux all approved - please merge, deploy and publish THANKS!

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