Skip to content

docs: update all references from astro-icon to @dallay/astro-icon - #5

Open
yacosta738 wants to merge 35 commits into
twodft:mainfrom
dallay:update-docs-to-dallay-astro-icon
Open

yacosta738 wants to merge 35 commits into
twodft:mainfrom
dallay:update-docs-to-dallay-astro-icon

Conversation

@yacosta738

Copy link
Copy Markdown

Summary

Updates all documentation references from the old astro-icon package to the new @dallay/astro-icon package. This includes:

  • Installation commands (npm, pnpm, yarn)
  • Import statements in code examples
  • GitHub links pointing to the new repository
  • Changelog and issue links

Changes

  • getting-started.mdx - Updated install commands and imports
  • index.mdx - Updated GitHub repo link
  • configuration.mdx - Updated all code examples
  • components.mdx - Updated import statements
  • customization.mdx - Updated import statements
  • upgrade/v1.mdx - Updated install commands and imports

Verification

  • Documentation builds successfully with npm run build
  • 0 errors, 0 warnings in astro check

This fork maintains the package under @dallay/astro-icon, so the documentation now correctly points users to the new package.

yacosta738 and others added 30 commits May 15, 2026 15:53
- Add release-please-config.json for packages/core (@dallay/astro-icon)
- Add .release-please-manifest.json with current version 1.2.4
- Add release-please.yml workflow: auto PR on push to main, publish to npm on release
- Convert release.yml to manual fallback with explicit confirmation guard
- Remove .changeset directory and @changesets/* dependencies
- Remove changeset version script from root package.json
- devalue >= 5.8.1 (DoS via sparse array)
- fast-uri >= 3.1.2 (host confusion + path traversal)
- minimatch >= 10.2.3 (ReDoS, 3 CVEs)
- path-to-regexp >= 6.3.0 (backtracking ReDoS)
- undici@<6 >= 5.29.0 (DoS, smuggling, CRLF)
- ajv >= 8.18.0 (ReDoS via $data)
- smol-toml >= 1.6.1 (DoS via nested TOML)
…ponents--@dallay/astro-icon

chore: release @dallay/astro-icon 1.3.0
- Replace prettier with @biomejs/biome ^2.4.15
- Add biome.json with formatter, linter, and files.includes config (Biome v2)
- Update package.json scripts: lint, lint:fix, format
- Rewrite CI lint job: drop wearerequired/lint-action, use native biome + git auto-fix steps
Run biome check --write and --unsafe to auto-correct formatting and safe lint issues
Added a security policy document outlining supported versions and vulnerability reporting.

Signed-off-by: Yuniel Acosta Pérez <33158051+yacosta738@users.noreply.github.com>
…dates (#4)

Bumps the npm_and_yarn group with 2 updates in the / directory: [postcss](https://github.com/postcss/postcss) and [yaml](https://github.com/eemeli/yaml).


Updates `postcss` from 8.5.8 to 8.5.14
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](postcss/postcss@8.5.8...8.5.14)

Updates `yaml` from 2.7.1 to 2.9.0
- [Release notes](https://github.com/eemeli/yaml/releases)
- [Commits](eemeli/yaml@v2.7.1...v2.9.0)

---
updated-dependencies:
- dependency-name: postcss
  dependency-version: 8.5.14
  dependency-type: indirect
- dependency-name: yaml
  dependency-version: 2.9.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Add .vercel to packages/www/.gitignore to prevent Vercel deployment artifacts from being committed. Keeps repository clean of environment-specific deployment metadata.
Co-authored-by: dallay-bot[bot] <172063952+dallay-bot[bot]@users.noreply.github.com>
…and demo (#6)

* fix(a11y): add aria-hidden, role=img, focusable=false to Icon component

- Rename _id to id so symbol/use references resolve correctly (bug fix)
- Rename _normalizedBody to normalizedBody to match template usage (bug fix)
- Add focusable='false' to prevent SVGs from being keyboard-focusable
  in IE/Edge and some Chromium builds (WCAG 2.1.1)
- Decorative icons (no title prop) receive aria-hidden='true' so
  assistive technologies skip them (WCAG 1.1.1)
- Meaningful icons (with title prop) receive role='img' so screen
  readers expose the title as the accessible name (WCAG 4.1.2)
- Associate desc element with a stable id for future aria-describedby
  wiring (WCAG 1.1.1)

* fix(a11y): add skip link, <main> landmark, and meta description to base layout

- Wrap slot in <main id='main-content'> to provide a navigation
  landmark that keyboard and AT users can target (WCAG 1.3.6, 2.4.1)
- Add skip link that becomes visible on focus so keyboard users can
  bypass repeated header content (WCAG 2.4.1 - Level A)
- Add meta description for better AT context and SEO
- Skip link uses tabindex='-1' on <main> to allow programmatic focus
  without disrupting natural tab order

* fix(a11y): add explicit imports, title props, and star rating semantics in demo pages

- Add explicit imports for Base layout and Icon component to replace
  implicit globals; makes component contracts clear and auditable
- Fix variable name: _icon -> icon so the runtime reference resolves
- Add title prop to standalone icons so they are exposed as role='img'
  with an accessible name to screen readers (WCAG 1.1.1)
- Wrap star icons in <figure aria-label='Rating: 4 out of 5 stars'>
  with a visually-hidden <figcaption> so the group meaning is
  communicated to AT users (WCAG 1.1.1, 1.3.1)
- Add .visually-hidden utility class following the standard SR-only
  clip pattern

* fix(ci): push lint fixes to branch ref instead of detached HEAD

actions/checkout on pull_request events checks out the merge commit,
leaving the runner in detached HEAD state. A plain 'git push' then
fails with exit 128 because there is no active branch to push to.

Fix: use 'git push origin HEAD:${HEAD_REF}' when github.head_ref is
set (PR context), falling back to plain 'git push' on direct pushes
to main where HEAD is always attached.

* fix(ci): resolve biome lint issues and harden auto-fix push step

- Add biome-ignore on normalizedBody variable (used in Astro template,
  outside Biome JS scope) to prevent false unused-variable warning
- Apply biome import order: sort imports alphabetically in demo pages
- Apply biome ternary formatting in Icon.astro (cosmetic only)
- Use --force-with-lease on push to guard against concurrent pushes
  while still protecting against accidental overwrite of others' work

* fix(a11y): add aria-describedby to svg and make star icons decorative

- Icon.astro: add aria-describedby to normalizedProps when desc is
  provided and icon is meaningful, binding <svg> to its <desc id>
  (WCAG 1.1.1 / 4.1.2)
- map.astro: remove per-star title props so each icon is decorative;
  the <figure aria-label> and <figcaption> carry the collective meaning
  and screen readers no longer announce each star separately
- Add explicit permissions blocks to all CI jobs (actions/missing-workflow-permissions)
  - lint job: contents: write (needed for git push on auto-fix)
  - smoke job: contents: read (read-only, follows least privilege)
- Add pnpm override for yaml >= 2.8.3 to patch stack overflow vulnerability
  (GHSA-xxx, yaml >= 2.0.0 < 2.8.3)

Closes code-scanning alerts #6 and #7
Closes dependabot alert #13
Co-authored-by: dallay-bot[bot] <172063952+dallay-bot[bot]@users.noreply.github.com>
yacosta738 and others added 5 commits May 16, 2026 19:13
…r options

Enhance README with additional package manager installation commands for better user guidance.
Co-authored-by: dallay-bot[bot] <172063952+dallay-bot[bot]@users.noreply.github.com>
- Update installation commands (npm, pnpm, yarn)
- Update import statements in code examples
- Update GitHub links to point to dallay/astro-icon
- Update changelog and issue links

This fork maintains the package under @dallay/astro-icon, so documentation
now points to the correct package.
Update documentation examples to import the scoped package name. Replaced instances of `astro-icon` with `@dallay/astro-icon` in packages/www/src/content/docs/reference/configuration.mdx so examples reflect the packaged module name.
Update Node runtime reference from 22.12.0 to 24.15.0 by changing .nvmrc and the "engines.node" field in package.json so local tooling and package metadata require the newer Node version.
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.

1 participant