TODOS.md

TODO

A list of things that must be done to complete the SDK documentation site. Items in bold must be completed before deploying the site for the first time.

General

• Apply new brand guidelines.
• Deploy MVP docs site.
• Revamp footer
• Add Legal pages
• Revamp Header
• Migrate to yarn
• Add index pages for the Web Console and API docs

Netlify

• Add npm run clean:api && npm run gen:api to build command.

Landing Page

• Replace Docusaurus example images.
• Rewrite copy.

Dashboard

• Create docs for the Dashboard.

Docs

• Remove danger warnings
• Vue2 Selecting a Treatment Variable
• Complete revamp of current SDK Documentation.
• Add documentation for translations and Config API in all SDKs
• Rewrite copy for consistency.
• Add text under every heading.
• Custom SCSS.
  • Add Support
  • Change styles.
• Update to Docusaurus@latest (When openapi has released new version).
• Add Ruby Documentation
  • Remove empty Docs
  • Re-add Ruby Docs
• Add VueJS language support with Prisma

API

• Change api-spec.yaml to online version.
• Create Lambda or Github Action to run generation command on spec update.

Segment.io

• Create docs for Segment.io

FAQ

• Create an FAQs page

Troubleshooting

• Create a Troubleshooting page