Docs/adapt usage guides

[kathrinschalber]

💡 What is the current behavior?

New options are missing from usage guides

GitHub Issue Number: #

🆕 What is the new behavior?

• IX-3692 add centered property to loading modal
• IX-3843 add isNonBlocking property to modal

👨‍💻 Help & support

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 focuses on improving the documentation and code quality of the Siemens Industrial Experience design system. It adapts usage guides by adding descriptions to tab items and incorporating new properties for loading modals and modals. Additionally, it introduces code formatting tools and updates dependencies to enhance project maintainability and accessibility.

Highlights

• Documentation Updates: This PR adapts usage guides by adding descriptions to tab items and incorporating new properties for loading modals and modals, enhancing user understanding and component usability.
• Code Formatting: Introduces .editorconfig, .prettierrc, and .prettierignore files to enforce consistent code formatting across the project.
• Dependency Updates: Updates @dotenvx/dotenvx and @noble/curves dependencies, and adds docusaurus-plugin-llms to enhance documentation generation and maintain project currency.
• Accessibility Improvements: Enhances accessibility guidelines with code examples and keyboard navigation patterns, ensuring better usability for all users.

Ignored Files

• Ignored by pattern: .github/workflows/** (3)
  • .github/workflows/build.yml
  • .github/workflows/deploy-gh-pages.yml
  • .github/workflows/pr.yml

Activity

• Added descriptions to tab items in component documentation.
• Introduced .editorconfig, .prettierrc, and .prettierignore for consistent code formatting.
• Updated @dotenvx/dotenvx and @noble/curves dependencies.
• Added docusaurus-plugin-llms for enhanced documentation generation.
• Improved accessibility guidelines with code examples and keyboard navigation patterns.

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. ↩

[gemini-code-assist]

Code Review

This pull request introduces a wide range of updates, primarily focused on improving the documentation structure, adding new content for component options, and integrating an 'Ask AI' feature. The changes include renaming markdown files for consistency, adding descriptions to frontmatter, and updating dependencies. Additionally, a new post-build plugin has been added to process markdown files for consumption by large language models. My review focuses on ensuring adherence to the style guide, improving code robustness, enhancing maintainability, and ensuring the safe construction of LLM prompts, particularly in the new scripts and components.