Skip to content

fix(docs): filenames #4702

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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

fix(docs): filenames #4702

wants to merge 12 commits into from

Conversation

mfranzke
Copy link
Collaborator

@mfranzke mfranzke commented Aug 7, 2025

Proposed changes

We still had some old references in our documentation to files that have been moved or renamed.

Types of changes

  • Bugfix (non-breaking change that fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (improvements to existing components or architectural decisions)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Further comments

@mfranzke mfranzke self-assigned this Aug 7, 2025
@mfranzke mfranzke requested a review from nmerget as a code owner August 7, 2025 08:12
@mfranzke mfranzke added 🐛bug Something isn't working 📕documentation Improvements or additions to documentation postReview labels Aug 7, 2025
Copy link
Contributor

github-actions bot commented Aug 7, 2025

🔭🐙🐈 Test this branch here: https://db-ux-design-system.github.io/core-web/review/fix-docs-filenames

@mfranzke mfranzke enabled auto-merge (squash) August 11, 2025 09:56
@mfranzke mfranzke moved this to 👀 In review in UX Engineering Team Backlog Aug 11, 2025
@mfranzke mfranzke removed their assignment Aug 11, 2025
Copy link
Contributor

@Copilot Copilot AI left a 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 fixes outdated file path references in documentation and configuration files that were pointing to old locations after files were moved or renamed. The changes ensure that import statements, documentation examples, and tooling configurations use the correct file paths.

Key changes:

  • Updated CSS/SCSS import paths to reflect reorganized directory structure (e.g., colorcolors, initdefaults)
  • Added documentation validation script to package.json and updated its configuration
  • Fixed file references in component development documentation

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
scripts/package.json Added test script for documentation file reference validation
scripts/check-docs.js Updated root directory path and excluded additional migration docs from validation
packages/foundations/docs/Colors.md Fixed CSS/SCSS import paths from color to colors directory
packages/foundations/README.md Updated theme import path from root to defaults subdirectory
packages/components/test/import-styles/simple-button/test.css Updated multiple import paths to reflect new directory structure
packages/components/test/import-styles/simple-button/main.js Updated import paths and improved comments for clarity
packages/components/README.md Updated CSS import paths to use new directory structure
package.json Removed duplicate test script that was moved to scripts workspace
docs/how-to-develop-a-component.md Fixed SCSS import paths in component development guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛bug Something isn't working 📕documentation Improvements or additions to documentation postReview
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

1 participant