Back to all reviewers

documentation formatting consistency

jj-vcs/jj
Based on 3 comments
Markdown

Maintain consistent formatting and style patterns across all documentation to improve readability and user experience. This includes using proper shell command notation, consistent punctuation choices, and aligned configuration examples.

Code Style Markdown

Reviewer Prompt

Maintain consistent formatting and style patterns across all documentation to improve readability and user experience. This includes using proper shell command notation, consistent punctuation choices, and aligned configuration examples.

For shell commands, use the $ prefix with explanatory comments:

$ jj upload   # "upload" is an alias using "jj util exec"

Choose consistent punctuation throughout documentation (prefer commas over em dashes for better readability):

time, exactly how Gerrit wants you to work

Maintain consistent configuration patterns across different tools and sections:

[language-server.rust-analyzer.config.rust-analyzer.rustfmt]
extraArgs = ["+nightly"]

This approach ensures that documentation maintains a professional, cohesive appearance and reduces cognitive load for readers by establishing predictable formatting patterns.

3
Comments Analyzed
Markdown
Primary Language
Code Style
Category

Source Discussions