search

flaxandteal / dewret

DEclarative Workflow REndering Tool
Apache License 2.0
1 stars 0 forks source link

Add glossary #25

Closed philtweir closed 2 months ago

philtweir commented 3 months ago

Begins a glossary.

elleryames commented 3 months ago

I know the focus of this PR is to add a glossary, which by its nature should contain only brief entries. Perhaps to complement this, I think the documentation would benefit from a short description along the lines of: "A dewret workflow is composed of one or more steps that may make use of both local and global parameters. Each step is defined by a dewret task that is created by using the @task() decorator, and each task may be used by multiple steps." Maybe at the top of workflows.md.

philtweir commented 3 months ago

That makes sense - this PR is mainly a placeholder, although one point I had meant to discuss on Thursday (and forgot) was how much duplication of third-party docs we intend to allow in our own documentation. Perhaps though, this is a good topic for a Github Discussion?

elleryames commented 2 months ago

I know the focus of this PR is to add a glossary, which by its nature should contain only brief entries. Perhaps to complement this, I think the documentation would benefit from a short description along the lines of: "A dewret workflow is composed of one or more steps that may make use of both local and global parameters. Each step is defined by a dewret task that is created by using the @task() decorator, and each task may be used by multiple steps." Maybe at the top of workflows.md.

Added in https://github.com/flaxandteal/dewret/pull/25/commits/b1e8e317ece73bf15509175aed33a1fb8c75cb4b . Thanks @KamenDimitrov97 !