Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Request: better/centralized documentation on syntax #1502

Open
jlumpe opened this issue Mar 19, 2022 · 3 comments
Open

Request: better/centralized documentation on syntax #1502

jlumpe opened this issue Mar 19, 2022 · 3 comments
Labels
enhancement New feature or request

Comments

@jlumpe
Copy link

jlumpe commented Mar 19, 2022

Most of the documentation in the "Defining Workflows" section is organized on the basis of goal or use case. This works but I feel it is also very important to have a some sort of a reference page that documents all syntax elements in a single place. A couple of really good examples of this are the documentation pages for Dockerfiles and GitHub Actions workflows.

This sort of exists in the "Writing Workflows" page with the EBNF grammar, but this is difficult to read and doesn't describe what any of it does. I don't think a whole lot would be needed here, just a few sentences for each thing and then it could link to other parts of the documentation that go into more detail.

I'd be willing to submit a PR to get the ball rolling on this if it's something that would be wanted.

@jlumpe jlumpe added the enhancement New feature or request label Mar 19, 2022
@jlumpe
Copy link
Author

jlumpe commented Jun 9, 2022

Possible duplicate of #1168

@corneliusroemer
Copy link
Contributor

Great idea to improve docs. By the way, the EBNF grammar in docs is outdated, see #2224

@johanneskoester
Copy link
Contributor

Hi. Thanks for the suggestion! Sure, any documentation improvement is highly appreciated, and I am happy to merge corresponding PRs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants