decidim / documentation

Documentation site for Decidim project built with Antora
https://docs.decidim.org/
9 stars 23 forks source link

[WIP] Fix vale errors #152

Open RCheesley opened 10 months ago

RCheesley commented 10 months ago

Hi folks!

🚧 WIP - still working on this PR.

πŸ‘‹ Intro

⚠️ This PR is based on #147 which should be merged first, ideally.

πŸ€” What's it doing?

This is a pretty monster PR which fixes a whole lot of spelling, grammar and other related issues.

NOTE: This does not address gendered terms, I was asked to split that into a separate PR - #151.

There are some general points which I've highlighted below and fixed project-wide:

🚨 Things I came across while working on this PR

πŸ’‘ Core changes we should recommend before changing in the docs

In these cases, I've had to use a command to turn off the failing Vale rules for the relevant blocks and then turn them back on again. These are strings from core, so I can't just change them in the docs as it wouldn't make sense to the user seeing something different in the application.

andreslucena commented 8 months ago

@RCheesley I see lots of conflicts here, maybe we can start a new one from develop and cherry-pick what we need from this branch?

RCheesley commented 8 months ago

Sure thing, it's quite a big task hence why it's taking so long!

plaindocs commented 4 months ago

@RCheesley drive by comment to say that even if the vale on / vale off don't work on RST headings, you can probably add My as an exception to the Case rule (though that would apply everywhere unless you get complicated).