Explore sharing docs between crates

[Hinton]

🎟️ Tracking

📔 Objective

This is a potential approach for sharing documentation between functions in multiple crates. Unfortunately rust doc only support string literals which means we need to do some hacks to expose the comment as a markdown which can be included.

1. Add docs_const to the function with documentation.
2. Update build.rs in the crate you want to access the documentation.
3. Add #[doc = include_str!("../doc/test.md")] to access the doc.

⏰ Reminders before review

• Contributor guidelines followed
• All formatters and local linters executed and passed
• Written new unit and / or integration tests where applicable
• Protected functional changes with optionality (feature flags)
• Used internationalization (i18n) for all UI strings
• CI builds passed
• Communicated to DevOps any deployment requirements
• Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
  team

🦮 Reviewer guidelines

• 👍 (:+1:) or similar for great changes
• 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
• ❓ (:question:) for questions
• 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
  issue and could potentially benefit from discussion
• 🎨 (:art:) for suggestions / improvements
• ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
• 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
• ⛏ (:pick:) for minor or nitpick changes

[github-actions]

Checkmarx One – Scan Summary & Details – d9230b40-1be3-4de4-9da1-6356d3f4c5ae

No New Or Fixed Issues Found