Polish autogen script - Githubissues

PaulRBerg commented 1 year ago

I got the autogen.sh script in a pretty good shape, but it still suffers from a number of bugs and missing features:

[ ] Events are not hyperlinked, e.g. {TransferAdmin} event should be turned into [TransferAdmin][URL] event
[ ] Core references in Periphery are not hyperlinked, e.g. {ISablierV2Lockup.cancel} should be turned into [ISablierV2Lockup.cancel][URL]#cancel
[ ] There are many stale _ italics that we don't want (for context, see https://github.com/foundry-rs/foundry/issues/4540)
[ ] Where it says "See the documentation in ...", we should put the actual referenced documentation (this might be easier to do once @inheritdoc becomes usable with contracts: https://github.com/ethereum/solidity/issues/14045)

sambacha commented 1 year ago

The git source links to the docs directory

docs/contracts/v2/reference/periphery/interfaces

sambacha commented 1 year ago

Pandoc filters may be able to help here along with the other natspec issues you have posted about @PaulRBerg https://pandoc.org/filters.html#but-i-dont-want-to-learn-haskell

PaulRBerg commented 1 year ago

Thanks @sambacha, will have a look

PaulRBerg commented 10 months ago

Future note for self:

If https://github.com/sablier-labs/v2-docs/issues/119 gets implemented first, we might want to discard the first task above.

sablier-labs / docs