/fiv_1

fiv_1

Primary LanguageTypeScript

Navbar content

SDKs

you can find the SDKs content in the ./src/snippets/sdks.html. This file is divided into 2 parts, SECTIONS and SUB SECTIONS as below:

Resources

Guides, Support ...

The other items behavior in the navbar is editable from the navbar object in the docusaurus.config.js file. You can find it in the line 116

Search

You can replace ALGOLIA credentials in the line 213 in the docusaurus.config.js file.

Homepage content

Hero

Hero Json File

Pills

SDKs Section Json File

API Reference

API Reference Json File

Resources

Resources Json File

Cards (Help Section)

Cards Json File

Last Component (Community Section)

Community Json File

Footer

Footer Json File

API Reference

Postman Button

Replace the postmanUrl with your own Postman Run in Postman button URL in the ./src/components/RunInPostmanButton.tsx file.

Stoplight yaml files

Place your yaml files from stoplight in the ./static/api folder.

Versioning

Docusaurus Documentation

FAQ

Change the questions and answers in the ./src/faq.yaml file.

Questions

  1. How to create those category drop-down and version drop-down for two separate sections?

    • by providing an object like that in the docs_list.json, you gonna defined a category with 1 version:

      {
  "id": "first-first-category",
  "path": "docs/first-first-category",
  "routeBasePath": "/first-first-category",
  "lastVersion": "current",
  "versions": {
    "current": {
      "label": "2.2.3"
    }
  }
}

    • Create a your_new_docs_title + _versioned_docs folder (as in first-first-category_versioned_docs) and place your docs in it. all your new docs versions gonna be placed there: check the official documentation

    • create a your_new_docs_title + _versioned_sidebars file (as in first-first-category_versioned_sidebars) and place your sidebar in it. all your new docs versions gonna be placed there: check the official documentation

    • create a file where you gonna defined the list of your versions: your_new_docs_title + _versions.json (as in first-first-category_versions.json)

  2. How to create multiple API pages with different postman collection?

    • the API pages are autogenerated from the stoplight yaml files placed in the ./static/api folder. You can create as many API pages as you want by placing your yaml files in this folder. The API pages are generated in the ./src/pages/api folder.
    • Different postman collection? It has to be manually done, by creating new pages or by passing new parameters to the URL that gonna defined which postman collection to use. (this is not implemented in the application)!

  3. How to update top nav items and drop downs?

    • The top nav items are defined in the docusaurus.config.js file. You can find it in the line 116

    • an example for a simple item is:

         {
    label: "Guides",
    to: "guides",
    position: "left",
    className: "new-badge",
  },

    • an example of a dropdown:

          {
        label: "SDKs",
        type: "dropdown",
        className: "my-website-dropdown",
        items: [
            {
            type: "html",
            value: sdksHTML,
            className: "my-website-dropdown",
            },
        ],
        }

  4. How do I update the docusaurus template in my own?

    • You can find the docusaurus template in the ./src folder. All Reactjs pages are rendered from the pages folder.
    • You can find the docusaurus components in the ./src/components folder.
    • You can update the default docusaurus components in the ./src/theme folder.

  5. fiv-1.vercel.app/react-chat-sdk Chat > SDKs > React, So how do we add these per section?

    Same as https://fiv-1.vercel.app/first-first-category with https://fiv-1.vercel.app/first-second-category ...

    I guess the Chat, SDKs and React, each one gonna has its own versions list, so it's required that each one has its own folder with the versioned docs and versioned sidebars. Means each one with its own path.

  6. https://fiv-1.vercel.app/chat/sdk/react (and not https://fiv-1.vercel.app/react-chat-sdk)

    • Gonna required too much work, while we can't use the default docusaurus navigation behavior,