-
Notifications
You must be signed in to change notification settings - Fork 7
chore(landing): match recent changes in the structure #1050
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the changes—index.mdx: a couple of style fixes; please apply the inline suggestions.
| href="/contract-dev/carry-value" | ||
| cta="Carry-value pattern" | ||
| href="/contract-dev/first-smart-contract" | ||
| cta="Your first smart contract" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[HIGH] Second-person pronoun “your” introduced
The CTA label uses the second-person pronoun “Your” (“Your first smart contract”), which violates the style rule banning “you/your” in documentation. This line is part of the PR diff and introduces a [HIGH]-severity style issue. See the style rule “Don’t get personal” in https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L163-L166 for justification.
| cta="Your first smart contract" | |
| cta="First smart contract" |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| title="Your first TON dApp" | ||
| icon="mobile-notch" | ||
| <JourneyStep | ||
| title="Your first smart contract" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[HIGH] Second-person pronoun “your” introduced
The JourneyStep title uses the second-person pronoun “Your” (“Your first smart contract”), which violates the same style rule prohibiting “you/your”. This line is in the PR diff and therefore in scope. The rule “Don’t get personal” is documented at https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L163-L166.
| title="Your first smart contract" | |
| title="First smart contract" |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the improvements. In index.mdx, I left a couple of suggestions; please apply the inline suggestions.
| href="/contract-dev/carry-value" | ||
| cta="Carry-value pattern" | ||
| href="/contract-dev/first-smart-contract" | ||
| cta="Your first smart contract" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[HIGH] Second-person pronoun used in CTA label
The CTA label uses “Your first smart contract,” which addresses the reader directly. The style guide forbids using “you/your” to refer to the reader and marks this as HIGH severity (see contribute/style-guide-extended.mdx:163–166). Replace with a neutral label to comply with the documentation voice rules.
| cta="Your first smart contract" | |
| cta="First smart contract" |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| title="Your first TON dApp" | ||
| icon="mobile-notch" | ||
| <JourneyStep | ||
| title="Your first smart contract" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[HIGH] Second-person pronoun used in journey step title
The journey step title uses “Your first smart contract,” which violates the style rule against second-person pronouns (contribute/style-guide-extended.mdx:163–166). Use a neutral title to align with the documentation standards.
| title="Your first smart contract" | |
| title="First smart contract" |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
Closes #1040