search

bazelbuild / stardoc

Stardoc: Starlark Documentation Generator
Apache License 2.0
108 stars 45 forks source link

Fix Typo and Improve Documentation Consistency in README.md #249

Open KaranDasA1 opened 3 months ago

KaranDasA1 commented 3 months ago

248

This pull request addresses minor issues in the README.md file for Stardoc:

Typo Correction: The heading "Maintaner's guide" has been corrected to "Maintainer's guide." Link Verification: Ensured that all links, including the build status badge and external references (e.g., Starlark), are accurate and functional. Heading Consistency: Updated the documentation to ensure consistent use of heading levels, particularly under the "Get Started" and other major sections. These changes improve the clarity, usability, and professional presentation of the documentation.

google-cla[bot] commented 3 months ago

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.