Skip to content

feat: improve the readme.md#776

Merged
xmfcx merged 1 commit intoautowarefoundation:mainfrom
xmfcx:feat/readme
Feb 25, 2026
Merged

feat: improve the readme.md#776
xmfcx merged 1 commit intoautowarefoundation:mainfrom
xmfcx:feat/readme

Conversation

@xmfcx
Copy link
Copy Markdown
Contributor

@xmfcx xmfcx commented Feb 25, 2026

Description

This PR modernizes the repository's README and adds a missing .gitignore entry for Python virtual environments.

Changes

.gitignore

  • Add /.venv/ to ignore Python virtual environment directories

README.md

  • Redesigned with a centered logo, CI badge, and license badge
  • Added a clear project description and link to live documentation
  • Added a Getting started locally section with step-by-step setup instructions (clone → venv → install → serve)
  • Expanded Contributing section with a note about reviewing guidelines before submitting a PR
  • Added License section referencing Apache 2.0
  • General copy and formatting improvements throughout

Motivation

The previous README lacked onboarding instructions, making it harder for new contributors to run the docs site locally. The updated README brings it in line with common open-source project conventions and reduces friction for first-time contributors.

Before & After

image

How was this PR tested?

Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
@xmfcx xmfcx added the tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Feb 25, 2026
@github-actions
Copy link
Copy Markdown

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

@xmfcx xmfcx requested a review from mitsudome-r February 25, 2026 11:01
@xmfcx xmfcx self-assigned this Feb 25, 2026
@github-actions
Copy link
Copy Markdown

@xmfcx
Copy link
Copy Markdown
Contributor Author

xmfcx commented Feb 25, 2026

This can be checked here: https://github.com/xmfcx/autoware-documentation/blob/4a71273a1d7dfb432455822e9a133b841b5a8feb/README.md

this is not part of the deploy docs mkdocs pipeline

@xmfcx xmfcx enabled auto-merge (squash) February 25, 2026 11:03
@xmfcx xmfcx requested a review from isamu-takagi February 25, 2026 11:06
@xmfcx xmfcx merged commit 44fd03d into autowarefoundation:main Feb 25, 2026
18 of 19 checks passed
@xmfcx xmfcx deleted the feat/readme branch February 25, 2026 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants