-
Notifications
You must be signed in to change notification settings - Fork 124
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Documentation Link
No response
Describe the problem
Describe the improvement
Here are the proposed changes for the docs structure.
-
Notifications: Moving it back to platform level (separate section, not under Automation)
- It's a platform feature for both Automation and Embedded
-
Getting Started: Keeping at top level
- Will ensure it guides users to both Automation and Embedded paths
- Currently focused on Automation path
-
Commit format: Will include ticket numbers
- What's the ticket number for the docs restructuring work?
Regarding FumaDocs:
Thanks for the guidance! I'll:
- Edit markdown files in
/docs/content/docs/ - Run locally in dev mode to preview changes
- Need help setting up the local dev environment - any setup docs?
Updated Structure (with Notifications separate):
Getting Started
├── Welcome (Docs intro, value prop, where to get started)
├── Introduction (What is ByteChef, use-cases)
├── Glossary (Major key terms for Bytechef)
└── Quick Start (Cloud Usage, self-hosted usage, ans simple tutorial)
Self-Hosting (docs all deployment options)
├── 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 (should include diagrams,and context on major things that makes up ByteChef)
└── Overview
Platform
├── Overview (optional)
├── Notifications
│ ├── Overview
│ └── Configuration
├── (Other platform-level docs, if any)
Automation
├── Overview (automation capabulities)
├── Connect Data (this should entail how to connect to third -party applications via the connection tab in the platform)
│ ├── Overview
│ ├── How-To Guides
│ └── Reference
│ └── Connections
├── Build Workflows
│ ├── Overview
│ └── How-To Guides
├── 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
├── Introduction (Embedding Bytechef in applicatins)
├── Glossary
└── Quick Start (Quick example on the embedded feature)
Developer Guide
├── Overview
├── Development Environment
├── Build Components
│ ├── Overview
│ ├── Create Component Definition
│ ├── Add Connection
│ ├── Create Action
│ └── Create Trigger
├── Generate Components
│ ├── Overview
│ ├── OpenAPI Specification
│ ├── Customize Component
│ └── Create Trigger
├── Testing Triggers
├── Component Specification
│ ├── Component
│ ├── Connection
│ ├── Trigger
│ ├── Action
│ └── Property
└── Contribute
Reference
├── Components (Over 200+ components, template-based + examples for major ones.)
├── Flow Controls
└── Expressions
API Specification
└── (content to be added via Open API)
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation