Skip to content
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

docs: Fix Markdown Lint Errors in Communication Best Practices Guide #123

Merged
merged 2 commits into from
Apr 2, 2024

Conversation

cubxxw
Copy link
Contributor

@cubxxw cubxxw commented Apr 2, 2024

This PR addresses the Markdown linting errors reported by the CI/CD pipeline for the 11-communication_best_practices.md document within the GSoC Guides repository. The reported issues were primarily related to trailing spaces and the formatting of lists, which could potentially hinder proper rendering on the website. Here are the specific changes made:

  • Removed trailing spaces that violated MD009/no-trailing-spaces rule.
  • Ensured that lists are surrounded by blank lines, correcting the MD032/blanks-around-lists errors.

By resolving these linting issues, this PR aims to improve the readability and maintainability of the Communication Best Practices guide, ensuring that it adheres to the Markdown standards expected by our documentation pipeline.

Link to the CI/CD error report: CI Error Report

These changes were made in response to the CI/CD process identifying formatting inconsistencies that could affect the presentation of the document. Ensuring that our documentation meets these standards is crucial for maintaining a high-quality guide for GSoC participants.

@rspier rspier merged commit a4543ae into google:master Apr 2, 2024
2 checks passed
@cubxxw cubxxw deleted the patch-1 branch April 3, 2024 01:43
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.

2 participants