Skip to content

Add documentation guides for multi-contract projects, CLI installation, audit warnings, and resource limits - #239

Merged
SarahDoma merged 1 commit into
soroban-testkit:mainfrom
balisdev:feature/documentation-guides
Oct 21, 2026
Merged

SarahDoma merged 1 commit into
soroban-testkit:mainfrom
balisdev:feature/documentation-guides

Conversation

@balisdev

Copy link
Copy Markdown
Contributor

Closes #164, Closes #165, Closes #166, Closes #167

Summary

This PR adds four new comprehensive documentation guides to the Soroban Testkit Interface to enhance developer experience and troubleshooting capabilities.

Changes

1. FAQ: Common CLI installation errors (#165)

  • Comprehensive troubleshooting guide for installation issues
  • Covers Rust toolchain, WASM targets, PATH configuration, and system dependencies
  • Solutions for permission errors, missing tools, and platform-specific issues
  • Links to full installation guide and core repository for additional support

2. Guide: Resolving audit warnings (#166)

  • Categorized guide for authentication, arithmetic safety, and TTL warnings
  • Specific resolution patterns for each warning type
  • Code examples for common fixes
  • Guidance on using strict mode and regression testing

3. Guide: Interpreting resource limit results (#167)

  • Detailed explanation of limits command output (instruction count, memory usage, boundaries)
  • Common scaling patterns and their implications
  • Optimization strategies for different scenarios
  • Best practices for batch size tuning and pagination

4. Examples: Projects with multiple contracts (#164)

  • Workspace structure examples and conventions
  • Coverage, audit, and limits workflows for multi-contract projects
  • Per-contract and workspace-wide testing patterns
  • Cargo.toml workspace configuration examples
  • Batch testing script for multiple contracts

Implementation Details

  • All guides are keyboard-accessible and screen-reader friendly
  • Expandable/collapsible sections maintain clean UI
  • Consistent styling with existing guide cards
  • Added state management for new guide panels
  • No breaking changes to existing functionality

Testing

  • Build successful: ✅
  • All guides properly expand/collapse
  • Keyboard navigation functional
  • ARIA labels and controls properly configured

…n, audit warnings, and resource limits

- Add FAQ section for common CLI installation errors with solutions
- Add guide for resolving audit warnings (auth, arithmetic, TTL)
- Add guide for interpreting resource limit results
- Add examples for projects with multiple contracts
- All guides are keyboard-accessible and expandable
@drips-wave

drips-wave Bot commented Oct 21, 2026

Copy link
Copy Markdown

@balisdev 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 5cbee64 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