Skip to content

Add documentation enhancements: quick reference, feedback links, release notes, and space handling - #243

Merged
SarahDoma merged 2 commits into
soroban-testkit:mainfrom
coding-may:feature/issues-172-175-enhancements
Oct 21, 2026
Merged

SarahDoma merged 2 commits into
soroban-testkit:mainfrom
coding-may:feature/issues-172-175-enhancements

Conversation

@coding-may

Copy link
Copy Markdown
Contributor

Overview

This PR implements four focused documentation enhancements to improve user experience and accessibility.

Changes

Quick Reference for All Commands (#173)

  • Added a comprehensive, printable quick reference section covering all three CLI workflows (coverage, limits, audit)
  • Includes command syntax, default values, and practical examples
  • Features print-optimized CSS for clean printouts
  • Accessible keyboard navigation and screen reader support

Path Handling Examples (#172)

  • Added explicit examples showing how to handle contract paths containing spaces
  • Included in the quick reference for all three commands
  • Added prominent note explaining the need to wrap paths with spaces in quotes
  • Examples demonstrate: "./my contracts/token" syntax

Documentation Feedback Links (#175)

  • Added feedback links beside each workflow guide (Coverage, Audit, Limits)
  • Links open GitHub issues with pre-populated title and documentation label
  • Accessible with proper ARIA labels and keyboard support
  • Opens in new tab with security attributes (noopener, noreferrer)

Release Notes Section (#174)

  • Added interface-visible CLI changes documentation in a modal dialog
  • Tracks version history with focus on user-facing changes
  • Includes this release (v0.4.0) with all four enhancements
  • Accessible via footer link, keyboard-navigable, screen-reader friendly
  • Links to core repository for complete implementation details

Testing

  • Build passes successfully (npm run build)
  • All new components are keyboard-accessible
  • Print functionality works correctly for quick reference
  • Responsive design tested for mobile and desktop viewports

Accessibility

  • All interactive elements have proper ARIA labels
  • Keyboard navigation supported throughout
  • Color contrast meets WCAG 2.1 AA standards
  • Screen reader announcements tested

Closes #172, Closes #173, Closes #174, Closes #175

- Add printable quick reference for all three CLI commands
- Include examples with paths containing spaces for all workflows
- Add documentation feedback links beside each workflow guide
- Add release notes modal showing interface-visible CLI changes
- Improve guide header layout with flexible actions container
- Add print media queries for quick reference printability

These enhancements improve documentation accessibility and help users
understand how to handle edge cases like paths with spaces.
@coding-may
coding-may force-pushed the feature/issues-172-175-enhancements branch from 10436e8 to 8567980 Compare October 21, 2026 17:08
Resolved merge conflict in src/styles.css by combining:
- Upstream features: module not-found page (soroban-testkit#137), download button (soroban-testkit#146), command history (soroban-testkit#147)
- Branch features: feedback links (soroban-testkit#175), quick reference (soroban-testkit#173), release notes (soroban-testkit#174)
@drips-wave

drips-wave Bot commented Oct 21, 2026

Copy link
Copy Markdown

@coding-may 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

@SarahDoma
SarahDoma merged commit 928310b into soroban-testkit:main Oct 21, 2026
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