mirror of
https://github.com/sartography/spiff-arena.git
synced 2025-02-23 14:48:35 +00:00
d67eab8e30
* docs: Update the documentation structure in the todo list * add full index * titlesonly * move documentation to reference * docs: Nest BPMN elements under a new "Elements of BPMN" section * not hidden * docs: Mark first three TODO items as completed * fix: Uncheck incorrect checkboxes in todo.md * move * move building diagrams to own section * renames * docs * move to explanation * explanation * reorder * move forms * rm todo * typo --------- Co-authored-by: burnettk <burnettk@users.noreply.github.com>
69 lines
2.1 KiB
Markdown
69 lines
2.1 KiB
Markdown
# Welcome to SpiffWorkflow's Documentation
|
|
|
|
**SpiffWorkflow: Streamline Your Processes with Ease.** SpiffWorkflow is a platform designed to help you automate and manage complex workflows efficiently.
|
|
|
|
**What SpiffWorkflow Does:** It provides a comprehensive suite of tools to model, execute, and monitor business processes, enabling organizations to improve productivity and transparency.
|
|
|
|
**Meeting Your Needs:** Whether you're looking to automate routine tasks or manage intricate workflows--including AI and Human-in-the-loop--SpiffWorkflow offers the flexibility and scalability to meet your business needs, in an open and standards-based package.
|
|
|
|
**Who Benefits from SpiffWorkflow:** Ideal for businesses of all sizes, SpiffWorkflow is perfect for process architects, IT professionals, and anyone looking to optimize their workflow management.
|
|
|
|
---
|
|
|
|
## In This Documentation
|
|
|
|
```{toctree}
|
|
:maxdepth: 2
|
|
:hidden:
|
|
|
|
tutorials/index
|
|
how_to_guides/index
|
|
explanation/index
|
|
reference/index
|
|
```
|
|
|
|
## [Tutorials](tutorials/index)
|
|
|
|
**Start here**: A hands-on introduction to SpiffWorkflow for new users.
|
|
|
|
## [How-to guides](how_to_guides/index)
|
|
|
|
**Step-by-step guides**: Covering key operations and common tasks.
|
|
|
|
## [Reference](reference/index)
|
|
|
|
**Technical information**: Specifications, APIs, architecture.
|
|
|
|
## [Explanation](explanation/index)
|
|
|
|
**Discussion and clarification**: Background covering key topics
|
|
|
|
```{toctree}
|
|
:maxdepth: 1
|
|
:caption: Debugging Diagrams
|
|
```
|
|
|
|
```{toctree}
|
|
:maxdepth: 1
|
|
:caption: Support & Administration
|
|
```
|
|
|
|
```{toctree}
|
|
:maxdepth: 1
|
|
:caption: DevOps - Installation & Integration
|
|
```
|
|
|
|
```{toctree}
|
|
:maxdepth: 1
|
|
:caption: Appendices
|
|
```
|
|
|
|
## Project and Community
|
|
|
|
SpiffWorkflow is an open-source project that welcomes community contributions, suggestions, and feedback.
|
|
|
|
- [Join our online chat](https://discord.gg/F6Kb7HNK7B)
|
|
- [Contribute](https://github.com/sartography/spiff-arena/blob/main/CONTRIBUTING.rst)
|
|
- [Roadmap](https://github.com/sartography/spiff-arena/issues)
|
|
- Thinking about using SpiffWorkflow for your next project? [Get in touch!](https://www.spiffworkflow.org/)
|