00-docs
This provides a template or starting point for the documentation of your company project.
The documentation is plain markdown in 00-docs/src/docs, rendered by the documentation app
(orch-doc, orchescala's 04-orch-doc, shipped in the orchescala jars) - no static-site
generator, no front matter.
The following files you need to adjust:
00-docs/src/docs
| - contact.md
| - development/instructions.md
| - development/onboarding.md
| - pattern.md
| - statistics.md
The following files will be created by ./helper.scala prepareDocs:
00-docs/src/docs
| - dependencies
| - catalog.md
| - devStatistics.md
| - directory.conf
| - index.md
| - overviewDependencies.md
| - release.md
So do not adjust them manually.
prepareDocs also creates the company's data folders for the two apps of the site - they are
never overwritten, the apps write into them:
00-docs
| - testdata
| - spec # orch-spec: process specifications (config/model.json, processes/, pages/)
| - ops # orch-ops: recurring errors in operation (model.json, errors/)
The local preview names them on the apps' start screen; a company can use other folders
(docsSpecDir, docsOpsDir) - see Development.
00-docs/site is the built site (publishDocs) - the company gateway serves it, older releases
keep their classic sites there (site/<company>/<tag>/).