Skip to content

fix(docs): improve README typography and spacing#14

Merged
jpoehnelt merged 5 commits intomainfrom
fix-readme-typography-9191279383099110513
Mar 3, 2026
Merged

fix(docs): improve README typography and spacing#14
jpoehnelt merged 5 commits intomainfrom
fix-readme-typography-9191279383099110513

Conversation

@jpoehnelt
Copy link
Copy Markdown
Member

Fixes typography and vertical spacing in the README per user request. This aligns the tagline/badges with the body text, adds breathing room below the badges, emphasizes the install code block with the "2x Rule", and decouples the Important callout from the preceding text.

Included a changeset for the @googleworkspace/cli patch.


PR created automatically by Jules for task 9191279383099110513 started by @jpoehnelt

- Remove center alignment for tagline and badges to match left-aligned body
- Add `<br>` after badges for visual separation before install block
- Increase whitespace above install block to emphasize it
- Add an empty line above `> [!IMPORTANT]` block to decouple it from previous paragraph

Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com>
@google-labs-jules
Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 3, 2026

🦋 Changeset detected

Latest commit: 3c515d7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@googleworkspace/cli Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the readability and visual presentation of the README.md file. It addresses typography, vertical spacing, and alignment issues to create a more polished and user-friendly introduction to the @googleworkspace/cli project. A changeset has also been added to formally record these documentation updates.

Highlights

  • README Typography: Adjusted typography and vertical spacing in the README.md file to enhance readability and visual appeal.
  • Layout Alignment: Aligned the tagline and badges with the main body text for a more consistent layout.
  • Spacing Improvements: Introduced additional vertical spacing below the badges and before the "Important" callout to improve visual separation.
  • Install Code Block Emphasis: Emphasized the npm install code block by adding extra vertical space, following the "2x Rule" for visual hierarchy.
  • Changelog Entry: Included a new changeset file for the @googleworkspace/cli package to document these documentation-related changes.
Changelog
  • .changeset/fix-readme-typography.md
    • Added a new changeset entry for the README typography and spacing fixes.
  • README.md
    • Improved typography and vertical spacing.
    • Adjusted alignment of tagline and badges.
    • Added extra spacing around the install code block and before the important callout.
Activity
  • PR was automatically created by Jules for task 9191279383099110513, initiated by @jpoehnelt.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request improves the typography and spacing in the README.md file. The changes remove centered alignment for the tagline and badges to align them with the body text, and add vertical spacing around the installation code block and the 'IMPORTANT' callout for better readability. The changes are well-aligned with the stated goals. I have one minor suggestion to use Markdown's native syntax for a line break for better consistency.

Note: Security Review has been skipped due to the limited scope of the PR.

jpoehnelt and others added 4 commits March 3, 2026 12:32
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
- Remove center alignment from tagline and badges
- Add space below badges
- Adjust spacing around install code block (remove borders, add empty line above)
- Add empty line above IMPORTANT callout

Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com>
- Change "When Google adds an API endpoint" to "When Google Workspace adds an API endpoint or method" to be more accurate.

Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com>
Per user request, removed all remaining Markdown horizontal rules (`---`) throughout `README.md` to create a cleaner, borderless design. All previous typography and spacing improvements remain intact.

Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com>
@jpoehnelt jpoehnelt merged commit d29f41e into main Mar 3, 2026
21 checks passed
@jpoehnelt jpoehnelt deleted the fix-readme-typography-9191279383099110513 branch March 3, 2026 20:53
shigechika pushed a commit to shigechika/gws-cli that referenced this pull request Mar 20, 2026
* fix(docs): improve README typography and spacing

- Remove center alignment for tagline and badges to match left-aligned body
- Add `<br>` after badges for visual separation before install block
- Increase whitespace above install block to emphasize it
- Add an empty line above `> [!IMPORTANT]` block to decouple it from previous paragraph

Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com>

* Update README.md

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* docs: improve README typography and layout

- Remove center alignment from tagline and badges
- Add space below badges
- Adjust spacing around install code block (remove borders, add empty line above)
- Add empty line above IMPORTANT callout

Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com>

* docs: refine copy after install code block

- Change "When Google adds an API endpoint" to "When Google Workspace adds an API endpoint or method" to be more accurate.

Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com>

* docs: remove horizontal borders from README

Per user request, removed all remaining Markdown horizontal rules (`---`) throughout `README.md` to create a cleaner, borderless design. All previous typography and spacing improvements remain intact.

Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com>

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: jpoehnelt <3392975+jpoehnelt@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant