Skip to content

Add spell check and link validation for documentation - #1701

Merged
Junirezz merged 2 commits into
Junirezz:mainfrom
Mosas2000:fix/ci-improvements-1664-1667
Oct 19, 2026
Merged

Junirezz merged 2 commits into
Junirezz:mainfrom
Mosas2000:fix/ci-improvements-1664-1667

Conversation

@Mosas2000

Copy link
Copy Markdown
Contributor

Summary

This PR implements four CI/CD improvements to enhance documentation quality, dependency security, and release transparency.

Changes

Spell Checking (#1664)

  • Added cspell configuration for markdown and documentation files
  • Created project dictionary with technical terms (Soroban, Freighter, yvUSDC, etc.)
  • Integrated spell check job in docs workflow
  • Prevents typos and enforces consistent spelling conventions

Link Validation (#1665)

  • Integrated lychee link checker in docs workflow
  • Validates both internal and external links in markdown files
  • Configured with retry logic and appropriate status code handling
  • Catches broken documentation links before merge

NPM License Validation (#1666)

  • Added license-checker-rseidelsohn to dependency security workflow
  • Implemented allowlist for approved open source licenses (MIT, Apache-2.0, BSD, ISC, etc.)
  • Validates licenses for both frontend and backend npm dependencies
  • Complements existing cargo-deny for Rust dependencies

SBOM Generation (#1667)

  • Generates SPDX SBOM for Rust workspace using cargo-sbom
  • Generates CycloneDX SBOM for frontend using @cyclonedx/cyclonedx-npm
  • Automatically attaches both SBOMs to GitHub releases
  • Improves supply chain transparency and security posture

Testing

CI workflows validated locally. Each job runs independently and gates on failures appropriately.

Resolves

Closes #1664
Closes #1665
Closes #1666
Closes #1667

@drips-wave

drips-wave Bot commented Oct 19, 2026

Copy link
Copy Markdown

@Mosas2000 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

- Implements cspell with project dictionary for common terms
- Adds lychee link checker to validate internal and external links
- Includes npm license allowlist validation for dependencies
- Generates SBOM artifacts for release transparency

Resolves Junirezz#1664, Junirezz#1665, Junirezz#1666, Junirezz#1667
@Mosas2000
Mosas2000 force-pushed the fix/ci-improvements-1664-1667 branch from 8b6904f to 0777316 Compare October 19, 2026 14:16
@Junirezz
Junirezz merged commit 4e2d17c into Junirezz:main Oct 19, 2026
9 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants