NO-ISSUE: docs(website): update formatting and remove line number references#60
NO-ISSUE: docs(website): update formatting and remove line number references#60
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request updates documentation formatting conventions across the website directory to improve maintainability and consistency. The changes establish new standards for referring to code elements without brittle line number references and enforce consistent quote styling through Prettier configuration.
Changes:
- Added guideline to AGENTS.md prohibiting line number references in documentation text
- Updated Prettier configuration to use double quotes instead of single quotes
- Applied formatting changes across all documentation files (removed quotes from frontmatter titles, updated import statements to use double quotes, removed line number references from instructional text)
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| website/AGENTS.md | Added new guideline prohibiting line number references in documentation text |
| website/.prettierrc | Changed singleQuote setting from true to false to enforce double quote usage |
| website/docs/reference/supported-devices.mdx | Removed quotes from frontmatter title |
| website/docs/getting-started/quickstart.mdx | Removed quotes from title, updated imports to double quotes, removed line number references from instructional text, updated field descriptions to use "The X field" pattern |
| website/docs/getting-started/prerequisites.mdx | Removed quotes from title, updated imports to double quotes, removed line number references from instructional text, changed bullet list from asterisks to hyphens |
| CONTRIBUTING.md | Simplified content to just "AGENTS.md" |
| CLAUDE.md | Created new file with content "AGENTS.md" |
There was a problem hiding this comment.
The new content "AGENTS.md" is unclear and lacks context. Consider restoring a more descriptive message such as "Refer to the AGENTS.md file for instructions" to provide clearer guidance to contributors. A bare filename without explanation is not helpful documentation.
1 participant
No description provided.