search

ordinals / ord

👁‍🗨 Rare and exotic sats
https://ordinals.com
Creative Commons Zero v1.0 Universal
3.86k stars 1.38k forks source link

Update JSON-API & Recursive documentation #3984

Closed cryptoni9n closed 1 month ago

cryptoni9n commented 1 month ago

fixes #3742

draft mode for now while I look for typos and test the links and menus

I'm not confident I have all of the endpoints captured here yet. Please comment if you see any missing.

cryptoni9n commented 1 month ago

I think this may be ready for a first review now.

raphjaph commented 1 month ago

This looks good so far!

I made some changes so that the examples can be expanded underneath. It's based on this. If you could transform the other things into that format, that would be great!

cryptoni9n commented 1 month ago

thanks Raph - I've used your examples to apply that format throughout. Is this more what you had in mind?

raphjaph commented 1 month ago

Yes, this looks great!

I've made some tweaks to the first two endpoints, if you could apply those to the rest as well.

Also could you apply the same template to the Recursion section of the docs and update the examples as well? I think we're missing some. Thanks!

EDIT: Just putting down some ideas here, not need to do this for now:

cryptoni9n commented 1 month ago

Yes, this looks great!

I've made some tweaks to the first two endpoints, if you could apply those to the rest as well.

sure, I've applied those changes throughout.

Also could you apply the same template to the Recursion section of the docs and update the examples as well? I think we're missing some. Thanks!

ok - should I make a new PR or would you like it in this one?

cryptoni9n commented 1 month ago

close/reopen to restart faulty tests

raphjaph commented 1 month ago

ok - should I make a new PR or would you like it in this one?

You can put it in this one

cryptoni9n commented 1 month ago

thanks Raph! I think it looks good, but when I do the rich diff display, the include doesn't look like it is rendering correctly. Perhaps the viewer isn't capable? Not sure... image

Also, I saw one other thing that needed to be removed so I took it out.

raphjaph commented 1 month ago

The include statement is for the mdbook builder. You can run it and display the docs with just serve-docs