Skip to content

docs: remove wokeignore directive#519

Merged
medubelko merged 2 commits into
mainfrom
remove-wokeignore-tutorial
Feb 4, 2026
Merged

docs: remove wokeignore directive#519
medubelko merged 2 commits into
mainfrom
remove-wokeignore-tutorial

Conversation

@a-velasco

@a-velasco a-velasco commented Jan 30, 2026

Copy link
Copy Markdown
Contributor
  • Have you updated CHANGELOG.md with relevant non-documentation file changes?
  • Have you updated the documentation for this change?

Removed instructions to delete .wokeignore from the tutorial, since it no longer exists. (#517)

Additionally, removed old wokeignore:rule= directives throughout the docs.

@a-velasco a-velasco added the documentation Improvements or additions to documentation label Jan 30, 2026

@rkratky rkratky left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@rkratky

rkratky commented Jan 30, 2026

Copy link
Copy Markdown
Collaborator

(Not in the scope of this quick fix, but we should also remove the invocations of wokeignore from the docs :-))

@a-velasco

Copy link
Copy Markdown
Contributor Author

(Not in the scope of this quick fix, but we should also remove the invocations of wokeignore from the docs :-))

@rkratky I think it makes sense to just re-scope this to remove all misleading mentions of woke. But I'm a little confused because there are three types of mentions besides the .wokeignore file:

  • make woke, which still exists but invokes Vale instead - so we leave this
  • The :woke-ignore: role, which is specified in the conf.py - so I assume we also leave this
  • wokeignore:rule= - is this a remnant from the original woke tool that should be replaced by the :woke-ignore: role?

@rkratky

rkratky commented Jan 30, 2026

Copy link
Copy Markdown
Collaborator

The :woke-ignore: role, which is specified in the conf.py - so I assume we also leave this

conf.py specifies both vale-ignore and woke-ignore, and I assume the latter is just to have some semblance of continuity from wokeignore. But in the guidance, I'd suggest instructing ppl to use vale-ignore.

wokeignore:rule= - is this a remnant from the original woke tool that should be replaced by the :woke-ignore: role?

Yes, but let's replace it by vale-ignore :)

@minaelee minaelee left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ty!

@medubelko medubelko changed the title docs: remove .wokeignore from tutorial docs: remove wokeignore directive Feb 4, 2026
@medubelko medubelko merged commit 757ee24 into main Feb 4, 2026
5 of 7 checks passed
@medubelko medubelko deleted the remove-wokeignore-tutorial branch February 4, 2026 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants