Skip to content

Commit

Permalink
docs: fixed details block formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
arctic-hen7 committed Jan 11, 2022
1 parent f6eb796 commit ab1acaa
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ workflows:
```
<details>
<summary>How does that work?<summary/>
<summary>How does that work?</summary>
This is the structure of a Tribble configuration file, which has one top-level property `workflows`. In this example, we define a workflow called `test` (which will be available at `/workflows/test` on the generated website) with several sections. We mark the section called *Start* as the `index`, so the workflow will start there. Then, we define a simple paragraph to be displayed, and then two buttons for navigating to different sections based on the user's input. Notice that, depending on which button the user presses, they'll accumulate different tags (e.g. selecting *Report Bug* would add the `C:bug` tag). In the *Report Bug* section, we define some inputs, a `text` input for a brief bug description (you'd probably use a `multline` in real life), a `multiline`, a `datetime-local`, and a `boolean`. Then, we create another button, which has `endpoint:` at the beginning of its link, which means it'll be sent to an endpoint, specifically the *Bug* endpoint. If we look at that under `endpoints:`, we'll see that it has a preamble paragraph and then some text, which the user will be able to copy into something like a GitHub issue. We then define the properties of a button that will send the user to the place where they can report the issue. Notice that the `text` field here uses `${...}` interpolation syntax, which allows it to reference the values of any inputs in the rest of the workflow. Here, we interpolate the bug description that the user gave. If an input isn't marked as `optional: true`, you can be certain that it will be present for interpolation here. The only other thing particularly of note is the *Documentation* endpoint, which isn't a reporting endpoint like *Bug*, but it instead just provides instructions. These instructional endpoints are particularly useful for walking a user through creating different types of pull requests to your project.
Expand Down

0 comments on commit ab1acaa

Please sign in to comment.