Skip to content

Commit

Permalink
finished docs for github workflows and contributing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Tridecatrix committed Oct 17, 2024
1 parent 6230cb5 commit ef2879f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 8 deletions.
Binary file added en/.gitbook/assets/workflow-check-results.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 2 additions & 8 deletions en/contributing/how-to-improve-the-help-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ On PRs, you are able to view the results directly on the PR (though you have to

On your local fork, you can check the results of the workflows in the Actions tab > All actions panel on Github as shown below. Click on a specific workflow and its run to check the results.

![Actions tab on Github](../.gitbook/assets/workflow-check-results.png)

### Notes on links workflow

Links to external resources that aren't essential should be added to `.lycheeignore`. Resources can change URL or be taken down, and it isn't the best use of contributor resources to constantly keep fixing them, so try to spare us the headache!
Expand All @@ -78,14 +80,6 @@ The best way to enter tables is to use this [Table Generator](http://www.tablesg

Use <https://github.com/koppor/gitbook-summary-generator>.

```
## Run workflows through Github
Another way to run the Lint and Check markdown links workflows is to use an online CI runner through the Github page. On your fork of the repo, navigate to the Actions tab on Github. From here you can see the workflows on the left, and choose to run them.
![../.gitbook/run-workflow-thru-github.png]
### How to rename files

The gitbook integration changes some of the file names and appends "(1) (2) (1)" or something like this.
Expand Down

0 comments on commit ef2879f

Please sign in to comment.