Update API Reference section with improved structure and flow #231
Conversation
Updated additional topics to have a similar look and feel, along with label updates and other misc changes
Signed-off-by: Paul Wozniczka <[email protected]>
✅ Deploy Preview for luxury-shortbread-acee05 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -13,24 +13,25 @@ The Vectara Console is a good way for you to get started with <Config v="names.p | |||
| you're ready to integrate the platform more deeply into your application, the | |||
| Corpus Admin APIs allow you to programmatically manipulate corpora and perform | |||
| many other operations within the system. These APIs enable new workflows for | |||
| organizations, like tracking usage of accounts and corpora. Check out this [blog post about managing multi-tenancy](https://vectara.com/managing-multi-tenancy-with-vectaras-new-management-apis/) for more details. | |||
| organizations, like managing corpora and tracking usage of accounts | |||
| and corpora. Check out this [blog post about managing multi-tenancy](https://vectara.com/managing-multi-tenancy-with-vectaras-new-management-apis/) for more details. | |||
There was a problem hiding this comment.
All blog posts now are at https://vectara.com/blog/XXX
This still works due to a redirect, but perhaps it's best to start pointing to the right URL?
| @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; | |||
| import {Config} from '@site/docs/definitions.md'; | |||
| import {vars} from '@site/static/variables.json'; | |||
|
|
|||
| The Create API Key endpoint lets you create new API keys, which you can | |||
| The Create API Key API lets you create new API keys, which you can | |||
There was a problem hiding this comment.
Is there a way to make "Create API Key" (name of the API) stand out more? e.g. with Create API Key or just bold?
There was a problem hiding this comment.
I was relying on the bold in the title to stand out (similar to the Stripe documentation, though they don't mention API or endpoint in a topic title). The code block style is typically used for objects/parms. We could ask the broad team for their thoughts for a future iteration if that works.
Signed-off-by: Paul Wozniczka <[email protected]>
I updated the API Reference structure to organize all of the many new endpoints we have added in recent weeks. The single Admin APIs section has been replaced with separate "Admin" API sections related to Account, Access, Corpus, and Document Admin. I also fixed several typos and adjusted labels and formatting so that the API Definition topics have more consistency.