Skip to content

Commit 0bff5a3

Browse files
committed
crystal nightly isn't required anymore
1 parent 35b1536 commit 0bff5a3

3 files changed

Lines changed: 3 additions & 8 deletions

File tree

docs/quickstart/ci.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,12 @@
33
You can build and publish the website automatically on push using GitHub Pages and GitHub Actions. Here's our recommendation:
44

55
???+ example ".github/workflows/deploy-docs.yml"
6-
```yaml linenums="1" hl_lines="2 13 17 19 23"
6+
```yaml linenums="1" hl_lines="2 15 17 21"
77
--8<-- "examples/simple/.github/workflows/deploy-docs.yml"
88
```
99

1010
???+ question "Why configure like this"
1111
* Do *not* disable the workflow for non-*master* branches or pull requests. It is nice to ensure that the site builds (there can be errors!), instead at the bottom we prevent only the actual *deploy* action from being executed on non-*master*/non-*pushes*.
12-
* Crystal Nightly is needed because this plugin relies on some improvements to Crystal's doc generator that haven't made it into a release yet.
1312
* Dependencies are installed from `requirements.txt`. Make sure you've [populated it](python-dependencies.md).
1413

1514
!!! tip

docs/troubleshooting.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
## Types aren't linkified in method signatures or aliases
44

5-
This works, but you need to use a *nightly* build of Crystal. Crystal has some recent improvements that haven't made it into a release yet (as of 0.35). The plugin needs those improvements, otherwise it gracefully degrades.
5+
Please make sure you're using the latest Crystal version - 0.36.0 at least. The plugin needs the included improvements, otherwise it gracefully degrades.
66

7-
If you have Crystal built locally, you might just `export PATH=/full/path/to/crystal/bin:$PATH` (as the plugin is hardcoded to use just `crystal`).
8-
9-
If you don't want to bother, you can opt to just use nightly Crystal [in CI, when the docs get auto-deployed](quickstart/ci.md) and assume that the links will work, even though you don't see them locally.
7+
Even if you haven't managed to get that version of Crystal locally, you can just rely on [CI auto-deployment](quickstart/ci.md) and assume that the links will work, even though you won't see them locally.
108

119
## The navigation sections look scattered
1210

examples/simple/.github/workflows/deploy-docs.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ jobs:
99
uses: actions/checkout@v2
1010
- name: Install Crystal
1111
uses: oprypin/install-crystal@v1
12-
with:
13-
crystal: nightly
1412
- name: Install Python
1513
uses: actions/setup-python@v2
1614
- name: Install Python libs

0 commit comments

Comments
 (0)