search

tailscale / tailscale

The easiest, most secure way to use WireGuard and 2FA.
https://tailscale.com
BSD 3-Clause "New" or "Revised" License
17.22k stars 1.31k forks source link

publicapi: create new home for API docs and split into catagory files #12116

Closed catzkorn closed 4 weeks ago

catzkorn commented 1 month ago

This change creates a new folder called publicapi that will become the future home to the Tailscale public API docs.

This change also splits the existing API docs (still located in api.md) into separate files, for easier reading and contribution.

Updates tailscale/corp#19526

samlinville commented 1 month ago

Thanks for doing this! Could we add the TOC to each individual page as well as the overview page? The individual pages are still quite lengthy.

catzkorn commented 4 weeks ago

Thanks for doing this! Could we add the TOC to each individual page as well as the overview page? The individual pages are still quite lengthy.

🖖🏻 ✅

soniaappasamy commented 3 weeks ago

@catzkorn did this include the new user invite and node invite docs? Those got added after this PR was opened I believe.

Also, I was gonna suggest we hold off on merging this until we decide if we're gonna migrate over to openapi docs, to avoid two migrations. Unless the existing api.md file is ready to be switched over to just the table of contents today? (I think we'll just want to make sure we're maintaining any links before doing that!) I just want to make sure we're not in a state where theres two potential sources of truth for docs. 🙏

Happy to help out, let me know how I can assist!