Skip to content

Commit

Permalink
tools: Document external link check
Browse files Browse the repository at this point in the history
 Document external link check in upgrade process. While at it: run it and fix
 broken URLs. Whoops.
  • Loading branch information
juliaogris committed Aug 24, 2024
1 parent 2c088db commit ed028a7
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 7 deletions.
11 changes: 10 additions & 1 deletion docs/development/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Upgrade Tools and Dependencies

We attempt to upgrade tools and dependencies once a month. This upgrade process
has four parts:
has five parts:

1. [Upgrade Hermitised Tools](#upgrade-hermitised-tools)
2. [Upgrade Go Dependencies](#upgrade-go-dependencies)
3. [Upgrade Frontend Tools](#upgrade-frontend-tools)
4. [Upgrade Playwright](#upgrade-playwright)
5. [Test External URLs](#test-external-urls)

Each step should follow in the listed order and be committed separately. Ensure
`make ci` still passes before continuing with the next step.
Expand Down Expand Up @@ -132,3 +133,11 @@ Commit changes and ensure the build still works with

[Playwright]: https://playwright.dev/
[Playwright Docker documentation]: https://playwright.dev/docs/docker

## Test External URLs

Run

make test-urls

to check that all external URLs are reachable.
11 changes: 10 additions & 1 deletion frontend/docs/development/upgrade.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 9 additions & 1 deletion frontend/docs/development/upgrade.htmlf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion frontend/learn/foundation/sequence/evy.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion frontend/learn/foundation/sequence/evy.htmlf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion learn/content/foundation/sequence/evy.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ including any text or drawings that your code generates.
![Screenshot of the Evy web playground](img/playground-screenshot.png)

[playground]: https://play.evy.dev
[Syntax by Example]: https://docs.evy.dev/syntax_by_example.html
[Syntax by Example]: https://docs.evy.dev/syntax-by-example.html
[Language Specification]: https://docs.evy.dev/spec.html

## Hello world in Evy
Expand Down
2 changes: 1 addition & 1 deletion pkg/md/testdata/sample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Heading 3

[link](https://exmpale.com)
[link](README.md)

```evy
print "code block sample"
Expand Down

0 comments on commit ed028a7

Please sign in to comment.