Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove internal API reference #5336

Merged

Conversation

mollykarcher
Copy link
Contributor

@mollykarcher mollykarcher commented Jun 7, 2024

The maintained versions of these docs live in https://github.com/stellar/stellar-docs

I did a mindnumbingly laborious passthrough to sanity-check that all of the content here was present in some form in the public developer docs. It appears that there is only one real difference (that I could find), and it's minimal. The public API docs for the Horizon-specific error responses (example) are lacking this attribute-level descriptions in a table format. This format is present in these internal docs and also for the non-horizon specific error responses in the public docs, as well as all successful API responses in the public docs. We can update the public docs with this if we want. But regardless, this seems like a pretty minor difference and there's no major content missing, so I vote we just kill all this off.

I also think we should delete SDK_API_GUIDE. This reads almost like it's the middle section of an onboarding checklist, so I'm guessing some of our old onboarding docs used to reference it. But we have this essence captured in our Platform onboarding docs internally.

@mollykarcher mollykarcher force-pushed the molly/main/remove-internal branch from d7649a8 to 46cc931 Compare June 7, 2024 19:37
@mollykarcher mollykarcher merged commit f30d114 into stellar:master Jun 7, 2024
31 checks passed
@mollykarcher mollykarcher deleted the molly/main/remove-internal branch June 7, 2024 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants