SSWConsulting / SSWConsulting/SSW.Rules

✨ Image Naming - Standardize image filenames to kebab-case across Rules V3 (TinaCMS)

Open
#2,680 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Needs Refinement YakShaver
Dominant language
TypeScript
Stars
26
Forks
17
Avg merge
14h 39m
Merged PRs (30d)
2

Description

Requested by: @tiagov8 via YakShaver.ai 🦬
cc: @tiagov8, @Marxoz, @PothieuG, @Freego1783 @Aibono1225 @hveraus

Hi Team!

  🟥  Watch the video (1 min 33 sec)

  Url from screen share: https://github.com/SSWConsulting/SSW.Rules.Content/blob/main/public/uploads/rules/book-developers-for-a-project/rule.mdx?plain=1

Pain

Create an automated task for Rules V3 (TinaCMS) to detect and rename image files that do not follow the SSW file naming convention. The task should standardize image filenames to kebab-case using lowercase letters and dashes instead of spaces or capital letters. It should also update all affected image references throughout the rules content to prevent broken links. Examples of issues identified include filenames with spaces, capital letters, non-descriptive date-based names, and inconsistent casing.

Acceptance Criteria
  1. An automated process exists to scan image filenames used in Rules V3 (TinaCMS).
  2. Image filenames containing spaces are renamed to use dashes.
  3. Image filenames containing uppercase letters are converted to lowercase.
  4. Non-descriptive image filenames are flagged or renamed to a descriptive kebab-case format where possible.
  5. All updated image filenames have their references automatically updated across the project.
  6. No broken image references exist after the renaming process is completed.
  7. The updated filenames comply with the SSW naming convention for documents and files.
  8. The automation can be rerun safely without creating duplicate or conflicting filenames.
Screenshot

Screenshot
Figure: Inconsistent image filenames with spaces, capitals, and non-descriptive names

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the referenced rule.mdx and inspect the repository for the Rules V3 image/content workflow. Determine where an automated, rerunnable filename scan and reference update belongs. Done means affected images use lowercase kebab-case, descriptive names are handled where possible, and no image references are broken.

Written by the indexing model from the issue text.

Assessment

Tech stack
nextjs, typescript
Domain
content, documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.