[odehsamuel]

Summary

Resolves #1005.

This PR improves documentation accessibility across the repository by replacing non-descriptive link labels (such as "docs", "View Guide", raw paths, and vague phrases) and bare URLs with descriptive link text that clearly identifies destinations and includes target filenames where linking to local files.

Key Changes

1. Descriptive Link Text for Local Files & Runbooks:

   • Replaced path-only link texts (e.g., [docs/error_codes.md](./error_codes.md) -> [the error codes reference (error_codes.md)](./error_codes.md)) across docs/API_REFERENCE.md and docs/COMPREHENSIVE_API_DOCS.md.
   • Updated vague labels (e.g., [maintenance window](./MAINTENANCE_WINDOWS.md) -> [maintenance window (MAINTENANCE_WINDOWS.md)](./MAINTENANCE_WINDOWS.md)) in docs/UPGRADE_AND_ROLLBACK.md and docs/COMMUNICATION_TEMPLATES.md.
   • Updated non-descriptive "View Guide" labels in docs/videos/README.md to specific companion guide filenames ([escrow-contract-walkthrough.md](escrow-contract-walkthrough.md), etc.).
   • Updated source file links in examples/README.md to include .rs extensions ([deploy_contract.rs](src/bin/deploy_contract.rs), etc.) matching the pattern used in sdk/examples/README.md.
   • Included target filenames in ADR links across docs/ADRs/README.md, docs/QUERY_OPTIMIZATION.md, docs/RETENTION_AND_PRUNING.md, docs/STORAGE.md, and docs/CONTRACTS.md.
   • Included module filenames in docs/error_codes.md ([balance.rs], [sanitize.rs]).

2. Replaced Bare URLs:

   • Replaced bare URLs in the installation table of docs/DEVELOPER_ENVIRONMENT.md with descriptive labels ([Rust installation guide](...), [Soroban CLI setup guide](...), etc.).
   • Converted bare Horizon URL in docs/TOKEN_SETUP.md into descriptive link text.
   • Replaced bare rustup URL in CONTRIBUTING.md with [rustup, the Rust toolchain installer](https://rustup.rs) and descriptive Soroban documentation links.

3. Cross-Repository & Sibling Repository Verification:

   • Audited README.md for references to sibling repositories (lumora-web, lumora-services, lumora-contracts, lumora-mobile, lumora-design-system). Verified that these entries under "Organization Repositories" are structural section headings rather than links, preserving existing destinations without introducing arbitrary external URLs.

4. Reference-Style Links & Destination Integrity:

   • Confirmed reference-style links (such as in CHANGELOG.md) are well-formed and valid.
   • Text-only edits: all original destination URLs have been preserved.

5. Noted Pre-Existing Issues (Reported Separately):

   • docs/ADMIN_MULTISIG.md (line 222) contains an author-local file path URL file:///c:/Users/hp/OneDrive/Desktop/GrantFox/stellarAid-contract/contracts/campaign/src/lib.rs. Preserved destination per the constraint not to alter destinations in this pass, reported here for follow-up.

Acceptance Criteria Checklist

• No link text is "here", "this", "link", "read more", "click here", or "docs"
• No bare URL is used as link text
• Links to files include the filename
• Cross-repository links name the destination repository
• Reference-style links are well-formed
• The change is a text-only edit; no destinations were altered
• Verified rendering and link integrity

[drips-wave]

@odehsamuel 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

[ayshadogo]

GBEW