-
-
Notifications
You must be signed in to change notification settings - Fork 7
Fixing docs #655
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
Fixing docs #655
Conversation
- Changed the title from "Bootstrap logo" to "Image Auto Clicker Auto Fill logo". - Updated the image ID from "img1" to "ImageAutoClickerAutoFill". - Modified the path ID from "Shape 2" to "AutoClickerAutoFill".
…te unused redirect file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR improves documentation accessibility, consistency, and navigation by addressing UI components, table formatting, and redirect handling. The changes focus on standardizing documentation formatting and enhancing the overall user experience.
- Updated icon component to use unique IDs for better accessibility and styling
- Standardized table formatting across documentation by removing fixed width attributes
- Added aliases for legacy URL redirects and improved navigation structure
Reviewed Changes
Copilot reviewed 28 out of 31 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
site/static/CNAME | Updated domain from docs.getautoclicker.com to getautoclicker.com |
site/src/libs/icon.ts | Added optional id property to SvgIconProps interface |
site/src/components/icons/AutoClickerAutoFillWhiteFillIcon.astro | Implemented unique ID generation and improved accessibility with better title |
site/src/components/header/Navigation.astro | Added specific ID for header icon instance |
site/src/components/footer/Footer.astro | Added specific ID for footer icon instance |
Multiple .mdx files | Standardized table formatting by removing width attributes and added aliases for redirects |
site/src/content/callouts/subscribe-callout.mdx | Converted paragraph structure to semantic list |
site/src/content/docs/action-value/function.mdx | Replaced span with Callout component for better consistency |
build/vnu-jar.mjs | Added HTML validator ignore patterns for video element attributes |
.github/workflows/docs.yml | Changed permissions from read to write for contents |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
site/src/components/icons/AutoClickerAutoFillWhiteFillIcon.astro
Outdated
Show resolved
Hide resolved
View your CI Pipeline Execution ↗ for commit ab067a5
☁️ Nx Cloud last updated this comment at |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Dharmesh <dharmesh.hemaram@gmail.com>
|
This pull request focuses on improving accessibility, maintainability, and consistency across the documentation and UI components. The main changes include updating icon usage for better uniqueness and accessibility, standardizing table formatting in documentation, and enhancing callout and alias usage for clarity and navigation.
UI and Accessibility Improvements:
AutoClickerAutoFillWhiteFillIcon
component to use a uniqueid
for each instance (usingcrypto.randomUUID()
), and updated the<title>
for better accessibility. The icon's<use>
and<image>
elements now reference this uniqueid
, and the icon is given a specificid
attribute in both the header and footer components for easier styling and targeting. [1] [2] [3]Documentation Formatting and Consistency:
Standardized table column formatting by removing fixed
width
attributes and ensuring consistent header and row markup across multipleaction-value
documentation files. This improves readability and maintainability. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16]Converted the subscribe callout from paragraphs to a semantic unordered list for better accessibility and structure.
Replaced a
<span>
with a<Callout type="info">
component in the function documentation for improved clarity and visual consistency.Added aliases to the action value overview documentation to support redirects from older or alternative URLs, improving navigation and discoverability.
Workflow and Validation Updates:
Changed GitHub Actions workflow permissions for documentation from
contents: read
tocontents: write
, likely to enable publishing or updating documentation artifacts.Added new ignore patterns to the HTML validator configuration to suppress known, non-critical validation errors related to the
video
element.