atlos icon indicating copy to clipboard operation
atlos copied to clipboard
verified publisher icon atlosdotorg

API docs improvements

Open noah-schechter opened this issue 1 year ago • 1 comments

I've made a few improvements to the API docs page:

  • I simplified the python examples to use the hosted URL, simplified variable names, and used optional parameters when appropriate.
  • I changed the structure of each endpoint explanation to more clearly explain parameters.
  • I added a section called "API Vocabulary" that explains slugs, IDs, and the hierarchy of content on Atlos.
  • I indicated that it's necessary to create a piece of source material to "house" an artifact.

noah-schechter avatar May 12 '24 04:05 noah-schechter

Deploy Preview for atlos-docs ready!

Name Link
Latest commit 68c683029043f0b63b5e1ff8137f73721932e08e
Latest deploy log https://app.netlify.com/sites/atlos-docs/deploys/6641a1461016e40008a5a5f6
Deploy Preview https://deploy-preview-975--atlos-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar May 12 '24 04:05 netlify[bot]