Starting to move the API endpoints over from the openAPI repository#1
Starting to move the API endpoints over from the openAPI repository#1ElliotFriend wants to merge 5 commits intoscript3:mainfrom
Conversation
Signed-off-by: Elliot J. Voris <elliot@voris.me>
Signed-off-by: Elliot J. Voris <elliot@voris.me>
Don't know if that's ultimately the best way to go, though... Signed-off-by: Elliot J. Voris <elliot@voris.me>
Signed-off-by: Elliot J. Voris <elliot@voris.me>
Signed-off-by: Elliot J. Voris <elliot@voris.me>
| @@ -0,0 +1,66 @@ | |||
| # Turret | |||
There was a problem hiding this comment.
I'm undecided if this should be the new home to the API docs.
Do others have thoughts and opinions?
If we do decide to port the API docs over, I think it would be better if it lived in a subpage.
IE
developers/API Docs/endpoint
Our YBX docs have an example of how this would be structured https://github.com/script3/yieldblox-docs/tree/master/technical-docs/protocol
There was a problem hiding this comment.
Also, I think I can just import the generated openApi file into the gitbook ui. This might be an easy add to get all the api docs in for me. I'll investigate.
There was a problem hiding this comment.
Agree with you about the subpage!
I think I may have misunderstood the purpose of this repo. On the notion brainstorm page, I read "Create a documentation 'hub' for all things Turrets" and thought it was a turrets-documentation-centric thing. Is it intended to be more related to the DocSprint, rather than long-term Turrets documentation?
2 participants
So far, I'm not sure if this is moving in the right direction or not. I've never contributed to a GitBook repo before, and I'm not sure what kinds of formatting would be best for some of it.
Wanted to start this PR early in case I'm heading in the wrong direction with this. Any feedback or thoughts?