Skip to content

[task]: Initial public documentation #538

Open
@ivicac

Description

@ivicac

Use https://starlight.astro.build/

  • Finish home page - Replace the right image on the landing page and fix text and links in the boxes
  • Define documentation main segments.
  • Define documentation hierarchy.
  • Define the structure of each segment.
  • Define and write the minimum required for initial release
  • Rewrite root README file
  • Add CODE_OF_CONDUCT file
  • Add CONTRIBUTING file
  • Add README file for documentation
  • Deploy documentation to docs.bytechef.io via GitHub pages
  • Open Discord server for the community
  • Set up GitHub Discussions
  • Move project to the root project space
  • Add local development setup guide under CONTRIBUTING file
  • Add description to root project page
  • Add Dictionary page
  • Define documentation template for components that will include, besides automatically generated content for triggers/actions and sections on how to get the information required to define connections, usage samples
  • Update GitHub README.md, check https://www.daytona.io/dotfiles/how-to-write-4000-stars-github-readme-for-your-project
  • Define possible module deployment configurations
  • Draw architecture diagrams
  • Draw diagrams for the service communication
  • Add web analytics
  • Embedded: SDK documentation
  • Expose all configuration properties that can be changed by users as environment variables
  • generated docs - check dynamic output, ARRAY_BUILDER and OBJECT_BUILDER
  • generated docs - Remove docs for removed components
  • embedded - SDK Component Reference
  • Configure CommandBar in-app help

Documentation hierarchy - work in progress:

Welcome
Automation
  Getting Started
    Introduction
    Glossary
    Quick Start
  Connect Data
    Overview
    How-To Guides
    Reference
      Connections
  Build Workflows
    Overview
    How-To Guides
    Reference
      Projects
      Workflows
      Triggers
      Actions
      Properties
      Outputs
  Deploy Workflows
    Overview
    How-To Guides
    Reference
      Environments
  Monitor Executions
    Overview
    How-To Guides
  Git Sync (How to configure Bytechef to read/write workflows from/to Git)
Embedded
  Getting Started
    Introduction
    Glossary
    Quick Start
Self-Hosting
  Install ByteChef
    Try ByteChef
    Docker
    Kubernetes
    AWS EC2
    AWS ECS
    Azure Container Instance
    Google Cloud Run
    DigitalOcean
  Configure Instance
    Environment Variables
  Manage Instance
  Manage Editions
  Architecture
    Overview
Developer Guide
  Overview
  Development Environment
  Build Component
     Overview
     Create Component Definition
     Add Connection
     Create Action
     Create Trigger
  Generate component
    Overview
    OpenAPI Specification
    Customize component
    Create Trigger
  Testing triggers
  Component Specification
    Component
    Connection
    Trigger
    Action
    Property
Contribute
Reference
  Components
  Flow Controls

Metadata

Metadata

Labels

documentationImprovements or additions to documentationtaskTask to do

Type

No type

Projects

Status

🔖 Ready

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions