Skip to content

Conversation

@hey-august
Copy link
Contributor

@hey-august hey-august commented Dec 28, 2025

Other Changes Pull Request

Description

Several changes intended to make terminal output less noisy for start and build commands and prepare for migration.

Command Output lines (Before) Output lines (After)
start 2037 138
build 15209 12945

These changes are organized into content and functionality categories:

Content

Reduce noisy output by fixing long-ignored alt text warnings produced by the remark-plugin-a11y-checker.

Warning Type Before After
Alt text punctuation 104 0 ✅
"Screenshot of" 15 0 ✅
Alt text too long 4 0 ✅
Starts with "image" 2 0 ✅
Empty alt text 21 0 ✅
PNG/GIF format 83 0 ✅ (turned off)
Total 229 0

Functionality

Remarkable plugin:
Turned off image format check, so it longer warns about PNG/GIF images not being webp/svg.
Rationale: We avoid unnecessary images in general. Future tools may handle image optimization for us. It's not a priority at this time.

Docusaurus Guide Showcase plugin:

  • Exclude more unwanted content types from checks:
    • **/_*.mdx, **/_*.md: Partial files
    • **/_common/**, **/_shared/**, **/_mermaid/**, **/_usecases/**, **/_sharedtables/**: Shared content directories
  • Silence tag warnings

Type of Change

  • Docusaurus update/maintenance
    • Dependency update
    • Configuration change
    • Plugin update
    • Bug fix
    • Style Change
  • Performance improvement
  • Refactoring
  • Build process update
  • Other (please specify):

Motivation and Context

start and build commands currently have very noisy outputs, with the following negative effects:

  • Noisy outputs overwhelm standard scrollback buffers, polluting shell history
  • It is token-inefficient to pipe command output into coding agents like Claude Code for debugging purposes

The warnings in these command outputs are, in many cases, valid accessibility issues that were trivial to solve with Claude.

Checklist:

  • My changes follow the style guidelines of this project
  • I have performed a self-review of my changes
  • My changes generate no new warnings
  • Builds successfully locally

Notes

  • Run yarn start-fresh (not yarn start) to let plugin changes take effect
  • The showcase plugin still logs "Processing file" lines (~124) - could be silenced in a follow-up

@netlify
Copy link

netlify bot commented Dec 28, 2025

Deploy Preview for signalwire-docs ready!

Name Link
🔨 Latest commit 336f4c3
🔍 Latest deploy log https://app.netlify.com/projects/signalwire-docs/deploys/6952d5eae0d5e7000810ee84
😎 Deploy Preview https://deploy-preview-767--signalwire-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 38 (🟢 up 11 from production)
Accessibility: 91 (no change from production)
Best Practices: 92 (no change from production)
SEO: 89 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/general General Issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants