🌐 Enabling transparent developer collaboration

[JFWooten4]

Motivation

Anyone should be invited to collaborate on our documentation. I think we can agree that the most common way to uncover the list-all-assets endpoint is through the public reference site, yes? ✏ Perhaps the pages thereon should have a direct modification link so we can build the best docs together!

Summary

Haven't heard back on obfuscation logic here yet, so I've implemented an open-access policy. 🤝

These changes enable the Edit this page button on the API endpoint specification docs and rectify minor syntax items. 👨‍💻

By making the data structure pages open to public upgrades, the introductions and underlying architecture efficiencies have a chance improve with each and every new reader. 🚀

[ElliotFriend]

Hi, @JFWooten4!

Thanks for the suggestions! Having these API docs as collaborative as possible is a great idea!! There's a technical hiccup here, though. All the pages you've modified are auto-generated using the docusaurus-plugin-openapi-docs package. All the specification files that feed into these pages are located in the /openapi/horizon directory. So, any changes/corrections to these *.api.mdx files will eventually be overwritten when the files get re-generated. Also, I'm not sure if there's a way to tell that plugin that we want the custom_edit_url to be left alone and/or specified to something custom.

I thought we had included some instruction on editing these pages in the main repo README, but evidently I'm mistaken. I think what I was remembering is the README that we wrote when this was the /api directory, and only included Horizon docs. Needless to say, that text is in a less-than-useful/obvious place, and we should have it far more prominently displayed.