Fixes doc links for procedural crate

[gupnik]

This PR fixes the documentation for FRAME Macros when pointed from polkadot_sdk_docs crate. This is achieved by referring to the examples in the procedural crate, embedded via docify.

[gui1117]

This is great, that mean all the macro doc can be moved from support to support-procedural isn't it 🤯

[gui1117]

As a sidenote I find it a bit unfortunate that there is no button to click on to access the underlying file.

If there was a source button it would be great IMO.

[bkchr]

This is great, that mean all the macro doc can be moved from support to support-procedural isn't it 🤯

But this still doesn't work for traits declared in frame-support.

[gupnik]

This is great, that mean all the macro doc can be moved from support to support-procedural isn't it 🤯

But this still doesn't work for traits declared in frame-support.

Could you expand this on a bit please? Since frame-support is added as a dev-dependency, we are able to use it in tests which are then embedded via docify. Let me know if I misunderstood.

[paritytech-cicd-pr]

The CI pipeline was cancelled due to failure one of the required jobs.
Job name: test-linux-stable 2/3
Logs: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6704585

[gui1117]

This is great, that mean all the macro doc can be moved from support to support-procedural isn't it 🤯

But this still doesn't work for traits declared in frame-support.

I tried, it seems pallet macro work in doc tests (even without docify), but runtime macro doesn't:

error[E0433]: failed to resolve: could not find `sp_api_hidden_includes_construct_runtime` in the crate root
  --> substrate/frame/support/procedural/src/lib.rs:287:1
   |
13 | #[frame_support::runtime]
   | ^^^^^^^^^^^^^^^^^^^^^^^^^ could not find `sp_api_hidden_includes_construct_runtime` in the crate root

But runtime macro could be fixed by using the same import style as pallet macro.

Maybe they changed the environment for doc test so that pallet is now successful.
Or maybe I always mistaken.

[kianenigma]

• have tried the RA experience? If you hover over a macro now, it will show the right one? a screenshot would be nice
• have you tried the situation where if you link from, for example a reference docs, to frame::pallet_macros::task using Rust's auto link resolved, it jumps to the right destination?

If yes to both, then it is green IMO.

Can you migrate the rest as well? and please take this as an opportunity and read the existing macro docs, and improve them if anything comes to mind.

These docs are not even more on the spotlight, as they are easily accessible via any IDE, and are the first thing that a developer will see once writing a pallet.

[gupnik]

have tried the RA experience? If you hover over a macro now, it will show the right one? a screenshot would be nice

Yes, PFA. Note that docify examples are not visible in the hover experience. Probably something to dig further at some point.

have you tried the situation where if you link from, for example a reference docs, to frame::pallet_macros::task using Rust's auto link resolved, it jumps to the right destination?

Yes.

Can you migrate the rest as well? and please take this as an opportunity and read the existing macro docs, and improve them if anything comes to mind.

Yes, but I would prefer to do it in a separate PR.

[kianenigma]

great stuff