Skip to content

Conversation

honzajavorek
Copy link
Collaborator

@honzajavorek honzajavorek commented Sep 8, 2025

Extracted from #1890 Context is explained by @TC-MO in this comment: #1890 (comment)

@mnmkng context for you, in /legal I moved <!-- vale off --> comment before frontmantter to not have the new rule targeting H1's affect anything. Also I've added I don't think you were using it and it was throwing a lot of false positives when working locally on docs repo. But if you are indeed using it, we can revert this change easily.

  • The goal here is it create new rule for Vale targeting H1's to prevent issues with the LLM buttons
  • It also led to issues with the custom rules I've created previously so this PR should fix that
  • I also took this opporunity to update the packages for write-good & msoft style guide that we use in docs

@honzajavorek honzajavorek requested a review from mnmkng as a code owner September 8, 2025 10:11
@honzajavorek honzajavorek requested a review from TC-MO September 8, 2025 10:11
@honzajavorek honzajavorek added documentation Improvements or additions to documentation. adhoc Ad-hoc unplanned task added during the sprint. t-docs Issues owned by technical writing team. labels Sep 8, 2025
@apify-service-account
Copy link

Preview for this PR was built for commit e922e96 and is ready at https://pr-1903.preview.docs.apify.com!

@honzajavorek honzajavorek mentioned this pull request Sep 8, 2025
@apify-service-account
Copy link

Preview for this PR was built for commit 317556b and is ready at https://pr-1903.preview.docs.apify.com!

Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

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

LGTM, but let's wait for @mnmkng approval as well

@honzajavorek honzajavorek merged commit 28303ea into master Sep 8, 2025
13 checks passed
@honzajavorek honzajavorek deleted the honzajavorek/ignore-legal branch September 8, 2025 17:41
@B4nan
Copy link
Member

B4nan commented Sep 9, 2025

This likely broke all the legal pages, I dont think you can put anything above the frontmatter.

The legal page now looks like this:

image

@TC-MO
Copy link
Contributor

TC-MO commented Sep 9, 2025

Apologies again, I should have tested it out more thoroughly 🙇‍♂️

patrikbraborec pushed a commit that referenced this pull request Sep 10, 2025
Extracted from #1890 Context is
explained by @TC-MO in this comment:
#1890 (comment)

> @mnmkng context for you, in `/legal` I moved `<!-- vale off -->
comment before frontmantter to not have the new rule targeting H1's
affect anything. Also I've added ` I don't think you were using it and
it was throwing a lot of false positives when working locally on docs
repo. But if you are indeed using it, we can revert this change easily.
> 
> * The goal here is it create new rule for Vale targeting H1's to
prevent issues with the LLM buttons
> * It also led to issues with the custom rules I've created previously
so this PR should fix that
> * I also took this opporunity to update the packages for `write-good`
& `msoft style guide` that we use in docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adhoc Ad-hoc unplanned task added during the sprint. documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants