docs: make the root README the portal welcome page
This commit is contained in:
parent
9f6e48fac5
commit
ed65effdab
26
README.md
26
README.md
|
|
@ -1,19 +1,17 @@
|
|||
# Wizard4Apps Docs
|
||||
# Wizard4Apps documentation
|
||||
|
||||
This repository is the **source of truth** for the in-app documentation portal
|
||||
(`/docs`). Content lives here, not in the application bundle — editing a file in
|
||||
this repository publishes the change without an app deploy.
|
||||
Welcome — this is where the platform explains itself. Everything here is written for people
|
||||
*using* Wizard4Apps: how the automation engine runs your workflows, what the widget system can
|
||||
build, and how the pieces fit together.
|
||||
|
||||
## Sections
|
||||
Pick a topic below, or use the navigation on the left. Pages are short and task-oriented; if
|
||||
something is missing or unclear, leave a comment under the page.
|
||||
|
||||
- **Elsa** — the workflows engine behind the **Elsa Flows** page (`/flows`).
|
||||
<div class="docs-note">
|
||||
|
||||
## Layout
|
||||
**How this works** — these pages are published from a separate public repository, not from the
|
||||
app bundle, so a correction ships by committing a file. Every top-level folder is a topic and
|
||||
each `README.md` inside it is that topic's index, which is why a new topic shows up here on its
|
||||
own.
|
||||
|
||||
```
|
||||
elsa/README.md -> /docs/elsa
|
||||
elsa/getting-started.md -> /docs/elsa/getting-started
|
||||
```
|
||||
|
||||
A top-level folder is a section; every other `.md` file inside it is a page.
|
||||
`README.md` is the section index page.
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in a new issue