[Docs]: AutoObserve Integration & Content Enhancements
Summary
This MR implements incremental improvements to the dev docs, focusing on better integration of AutoObserve documentation and fixing key content gaps that impact developer experience.
Key Changes
🔗 AutoObserve Documentation Restructure
- Integrated AutoObserve into Double-Spend Mitigation system
- Clarified the relationship between AutoObserve and LackSigning as complementary protection layers
- Emphasized key insight: Outbound transactions are signed and sent instantly, with AutoObserve preventing immediate rescheduling
- Removed duplicate sections for cleaner, more logical organization
🔧 Fixed Broken Links & References
- Updated main README.md affiliate guide references
- Fixed deprecated
saving-guidelinks to point to archived location - Corrected affiliate fee links to point to dedicated guide instead of generic fees page
- Verified API endpoint URLs are current and accessible
✨ Enhanced Existing Content
- Expanded dust threshold explanation with practical examples and economic context
- Improved gas rate documentation with chain-specific details and usage guidance
- Added comprehensive error handling examples to sending-transactions.md with real error codes
- Enhanced memo documentation with better cross-references and affiliate fee links
🧹 Terminology Standardization
- Maintained consistent "bonding vs staking" terminology usage
- Updated deprecated file references throughout documentation
- Standardized affiliate fee reference patterns across all documentation
Documentation Philosophy
This MR follows an incremental improvement approach rather than massive rewrites:
-
✅ Enhanced existing content with missing details -
✅ Fixed broken internal/external links -
✅ Added practical examples and error handling -
✅ Improved cross-references between related topics
Impact on Developer Experience
Before
- AutoObserve not within the docs
- Missing explanations for dust thresholds and gas rates
- Broken links interrupted developer workflows
- Limited error handling guidance
- Fragmented affiliate fee documentation
After
- AutoObserve clearly positioned as integral part of double-spend prevention
- Practical explanations of dust thresholds with real-world context
- Complete error handling examples with specific error codes
- Unified affiliate fee documentation with consistent linking
- Seamless navigation between related concepts
Files Modified
-
docs/README.md- Fixed broken links and updated references -
docs/concepts/memos.md- Enhanced dust thresholds, updated affiliate links -
docs/concepts/sending-transactions.md- Added comprehensive error handling section -
docs/concepts/querying-thorchain.md- Expanded gas rate explanation -
docs/bifrost/how-bifrost-works.md- Integrated AutoObserve into double-spend prevention -
docs/swap-guide/quickstart-guide.md- Updated affiliate fee references -
docs/SUMMARY.md- Updated navigation structure