Skip to content
New issue

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

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

Already on GitHub? # to your account

Book shows features before they're released #1607

Closed
Aloso opened this issue Jan 31, 2022 · 1 comment · Fixed by #1783
Closed

Book shows features before they're released #1607

Aloso opened this issue Jan 31, 2022 · 1 comment · Fixed by #1783
Labels
A-documentation Area: Documentation improvements C-enhancement Category: Improvements E-help-wanted Call for participation: Extra attention is needed

Comments

@Aloso
Copy link
Contributor

Aloso commented Jan 31, 2022

Go to https://docs.helix-editor.com/configuration.html. It includes the following example config:

theme = "onedark"

[editor]
line-number = "relative"
mouse = false

[editor.cursor-shape]
insert = "bar"
normal = "block"
select = "underline"

[editor.file-picker]
hidden = false

However, if you copy+paste this into ~/.config/helix/config.toml, helix shows this error on startup:

Bad config: unknown field `cursor-shape`, expected one of `scrolloff`, `scroll-lines`, `mouse`, `shell`, `line-number`, `middle-click-paste`, `smart-case`, `auto-pairs`, `auto-completion`, `idle-timeout`, `completion-trigger-len`, `auto-info`, `file-picker`, `true-color` for key `editor` at line 7 column 1
Press <ENTER> to continue with default config

The reason is that the cursor-shape config option was introduced after the latest version, helix v0.6.0. The book published at https://docs.helix-editor.com should reflect the state of the current version, not of the master branch.

@Aloso Aloso added the C-bug Category: This is a bug label Jan 31, 2022
@kirawi kirawi added A-documentation Area: Documentation improvements C-enhancement Category: Improvements and removed C-bug Category: This is a bug labels Jan 31, 2022
@archseer
Copy link
Member

archseer commented Feb 1, 2022

Yeah it builds against latest master instead of the release. I could use some help with the Github Actions set up so we'd have two different builds for stable & master.

@archseer archseer added the E-help-wanted Call for participation: Extra attention is needed label Feb 1, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-documentation Area: Documentation improvements C-enhancement Category: Improvements E-help-wanted Call for participation: Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants