Skip to content

Repository guide

Devon edited this page Dec 30, 2024 · 1 revision
├── Dockerfile
├── LICENSE
├── api
│   ├── compatibility-api
│   └── signalwire-rest
├── babel.config.js
├── config
│   ├── navbar.js
│   └── typesense.js
├── docs
│   ├── call-flow-builder
│   ├── cantina
│   ├── compatibility-api
│   ├── events
│   ├── guides
│   ├── home
│   ├── product-overview
│   ├── rest
│   ├── sdks
│   ├── swml
│   └── tools
├── docusaurus.config.js
├── env.example
├── netlify.toml
├── node_modules
├── package-lock.json
├── package.json
├── plugins
│   ├── docusaurus-plugin-showcase
│   ├── markdown-printer
│   ├── remark-plugin-a11y-checker
│   ├── remark-plugin-api-table
│   ├── remark-plugin-image-to-figure
│   ├── remark-plugin-vfile-reporter
│   └── remark-plugin-yaml-and-json
├── provisioning
│   └── nginx
├── scripts
│   ├── copy-markdown-export.js
│   ├── image-compliance-check.js
│   ├── image-conversion-windows.mjs
│   ├── image-conversion.mjs
│   └── merge-sitemaps.mjs
├── sidebars.js
├── sites
│   ├── _common
│   ├── compatibility-rest
│   ├── cxml-rest
│   ├── relay-rest
│   └── rest-api
├── src
│   ├── client-modules
│   ├── components
│   ├── css
│   ├── data
│   ├── pages
│   └── theme
├── static
│   ├── attachments
│   ├── bannerica.css
│   ├── bannerica.js
│   ├── img
│   ├── index.html
│   ├── landing-assets
│   ├── plugins
│   ├── readme-files
│   └── scripts
├── tsconfig.json
├── tspconfig.yaml
├── typesense.json
└── utils
    ├── blocks-convert.mjs
    ├── readme-code-convert.mjs
    └── readme-convert.mjs
  • .docusaurus - Configuration for Docusaurus.
  • api - Specification files for REST APIs.
  • build - HTML site content generated by npm run build.
  • config - Configuration files for the site navbar and Typesense search.
  • docs - Markdown files for the docs site.
  • node_modules (untracked) - Node.js modules installed by npm install.
  • plugins - Docusaurus plugins.
  • provisioning/nginx - Configuration for Nginx web server, including redirects.map.
  • scripts - Custom scripts run by the CI/CD pipeline to check for style issues and to convert images.
  • sites - Subsites.
  • src - Source code for the docs site, including:
    • components - Custom React components.
    • css - Custom stylesheets.
    • pages - Custom pages.
  • theme - Components for the default Docusaurus theme.
  • static - Static assets (images, attachments, tracking scripts, etc.) for the docs site.

A number of top-level files are used to configure site structure and development and production environments, including:

  • Dockerfile - Configuration for the Docker image used in the CI/CD pipeline.
  • docusaurus.config.js - The main Docusaurus configuration file.
  • package.json - Definitions for project-wide dependencies and build scripts.
  • sidebars.js - Configuration for the site Sidebars.