Skip to content

docs: Migrate org README to Markdown format#766

Merged
ReenigneArcher merged 1 commit into
masterfrom
docs-update-readmes
Jun 27, 2026
Merged

docs: Migrate org README to Markdown format#766
ReenigneArcher merged 1 commit into
masterfrom
docs-update-readmes

Conversation

@ReenigneArcher

Copy link
Copy Markdown
Member

Description

Replaces the legacy README.rst with a new root README.md that adds branded header content, badges, and improved localization/community sections while preserving the core project overview. Also updates profile/README.md to use the SVG logo image in the header for consistent branding across org-facing docs.

This is per LizardByte/roadmap#168

Screenshot

Issues Fixed or Closed

Roadmap Issues

Type of Change

  • feat: New feature (non-breaking change which adds functionality)
  • fix: Bug fix (non-breaking change which fixes an issue)
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.)
  • refactor: Code change that neither fixes a bug nor adds a feature
  • perf: Code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • build: Changes that affect the build system or external dependencies
  • ci: Changes to CI configuration files and scripts
  • chore: Other changes that don't modify src or test files
  • revert: Reverts a previous commit
  • BREAKING CHANGE: Introduces a breaking change (can be combined with any type above)

Checklist

  • Code follows the style guidelines of this project
  • Code has been self-reviewed
  • Code has been commented, particularly in hard-to-understand areas
  • Code docstring/documentation-blocks for new or existing methods/components have been added or updated
  • Unit tests have been added or updated for any new or modified functionality

AI Usage

  • None: No AI tools were used in creating this PR
  • Light: AI provided minor assistance (formatting, simple suggestions)
  • Moderate: AI helped with code generation or debugging specific parts
  • Heavy: AI generated most or all of the code changes

@ReenigneArcher ReenigneArcher marked this pull request as draft June 27, 2026 01:54
Replaces the legacy `README.rst` with a new root `README.md` that adds branded header content, badges, and improved localization/community sections while preserving the core project overview. Also updates `profile/README.md` to use the SVG logo image in the header for consistent branding across org-facing docs.
@ReenigneArcher ReenigneArcher marked this pull request as ready for review June 27, 2026 01:59
@ReenigneArcher ReenigneArcher merged commit a0ba34c into master Jun 27, 2026
18 checks passed
@ReenigneArcher ReenigneArcher deleted the docs-update-readmes branch June 27, 2026 02:11
@sonarqubecloud

Copy link
Copy Markdown

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