Conversation

Notices

1. Embed this notice
   Alex Gleason (alex@gleasonator.com)'s status on Saturday, 07-Jan-2023 09:04:25 JST Alex Gleason

   I’m working on a thing to pull the openapi spec from Rebased and display docs on the website automatically. Not taking the easy way out by using some prebuilt thing; I want it to look beautiful.

   The data fetching part is down, kinda. Still working on processing the data then styling.

   What’s neat about this is that adding new features to Rebased will make the website update automatically.

   • Embed this notice
     Alex Gleason (alex@gleasonator.com)'s status on Saturday, 07-Jan-2023 10:43:57 JST Alex Gleason

     in reply to

     • nekobit
     @nekofag

     /.well-known/api-docs

     Got any… docs? I don’t know what that’s supposed to look like.

   • Embed this notice
     nekobit (nekofag@rdrama.cc)'s status on Saturday, 07-Jan-2023 10:44:05 JST nekobit

     in reply to
     @alex can you add `/.well-known/api-docs` as a route which perm redirects to /rebased/api? i've got an idea i just need time :greedy_cirno: :marseyjewoftheorientglow:
   • Embed this notice
     nekobit (nekofag@rdrama.cc)'s status on Saturday, 07-Jan-2023 11:07:52 JST nekobit

     in reply to
     @alex its a generic route redirect like /.well-known/reset-password (it is silly but i guess it works)
     
     its still not a terrible idea, i could pitch it to mastodon and it just redirects to their docs page.
     
     i dont 2.1.json or /api/v1/instance works cuz its less about the instance and more about a generic route
     Alex Gleason likes this.
   • Embed this notice
     Alex Gleason (alex@gleasonator.com)'s status on Saturday, 07-Jan-2023 11:12:02 JST Alex Gleason

     in reply to

     • nekobit

     @nekofag I can 301 tho right? In that case it would be trivial to add, a one-liner. I’d do it right now if my laptop was in front of me, but I noted it already.

   • Embed this notice
     nekobit (nekofag@rdrama.cc)'s status on Saturday, 07-Jan-2023 11:12:03 JST nekobit

     in reply to

     • nekobit
     @alex ...cuz chances are, i might do something similar on wormhole, and the rest is up to everyone else. the only issue is that i dont think its good to have rebased/docs and wormhole/docs.. or is it /api.. or whatever, you get my idea, having a generic well-known route isnt a terrible idea. if u can do that ill do the same :)
   • Embed this notice
     nekobit (nekofag@rdrama.cc)'s status on Saturday, 07-Jan-2023 11:22:06 JST nekobit

     in reply to
     @alex yea 301 or whatever it doesnt matter
     Alex Gleason likes this.
   • Embed this notice
     Deus (deus@mastindia.co)'s status on Saturday, 07-Jan-2023 11:55:08 JST Deus

     in reply to

     Alex - Hats off to your dogged commitment to this project. Thank you again.

     Please note that while this will automate things but looking up simple things like blocking a domain or ‘what to do when stuck’ are not answered. I completely understand that there aren’t much contributors so you have to resort to this. But thought I should add my two cents as I want this project to succeed.

     To conclude, people (and certain companies) have tried this approach of automating documentation (or their Knowledge base) even using Postman but the results are not the best - users cannot find what they are looking for.

     Alex Gleason likes this.
   • Embed this notice
     Alex Gleason (alex@gleasonator.com)'s status on Saturday, 07-Jan-2023 11:55:57 JST Alex Gleason

     in reply to

     • Deus

     @Deus Fair point about needing a user guide, but if I can at least empower developers and technologists first, they can empower users. We’ll get there.

   • Embed this notice
     GNU Too (gnu2@gnusocial.jp)'s status on Saturday, 07-Jan-2023 11:59:21 JST GNU Too

     in reply to
     @alex @Deus from an end user perspective, if you need a user guide your HMI is not well designed
     Deus likes this.
   • Embed this notice
     Deus (deus@mastindia.co)'s status on Saturday, 07-Jan-2023 12:12:03 JST Deus

     in reply to

     • GNU Too

     gnu2, not mine ?

     If it’s not documented and does not have instructions of using it, it does not exist.