Skip to content

[Docs]: Improve README Badge Organisation #250

Closed

Description

@harryswift01

Documentation Update

The README.md needs to be updated to better organise the GitHub badges used in the CodeEntropy documentation. At present, the badges are not grouped or presented in a dedicated section.

Why Is This Needed?

An unstructured presentation of GitHub badges reduces readability and makes the top of the README harder to scan, particularly for new users. Organising the badges into a dedicated section would improve clarity and provide a more consistent and professional presentation of project metadata.

Suggested Changes

  • Introduce a clearly defined GitHub badges section near the top of README.md
  • Group related badges together (e.g. CI status, documentation, release/version information)
  • Present all badges within a single, consistent block or table

This change is limited to documentation layout and does not alter the badges themselves or any project functionality.

Additional Context

This is a documentation-only improvement intended to enhance readability and consistency. No changes to the CodeEntropy codebase or workflows are required.

Activity

  1. self-assigned this
    on Jan 20, 2026
  2. changed the title [-][Docs]:[/-] [+][Docs]: Improve README Badge Organisation[/+] on Jan 20, 2026
  3. linked a pull request that will close this issueIntroduce Table for GitHub Badges #252on Jan 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions