Skip to content

Conversation

@harryswift01
Copy link
Contributor

Summary

This PR ensures that the documentation for CodeEntropy reflects all of the changes that have been made within the v1.0.0 release.

Changes

Ensured the pyproject.toml and README.md are reflective of the changes in v1.0.0:

  • Updated GitHub badges to give a simplified overview of the codebase.
  • Updated description within pyproject.toml to ensure consistency with the README.md.
  • Included the specific Python versions that CodeEntropy is compatable with within the pyproject.toml.
  • Updated the project urls within pyproject.toml to ensure they are the correct entry points.
  • Upgraded the development status of CodeEntropy from 4 - Beta to 5 - Production/Stable
  • Changed the CodeEntropy logo to the locally sourced file within the docs folder

Updated .gitignore to exclude all folders and files generated by CodeEntropy:

  • The following folders and files will no longer be able to be pushed onto the repository.
    • job
    • .json
    • .err
    • .com
    • .txt

Updated .github/PULL_REQUEST_TEMPLATE.md:

  • Updated to follow more standardised markdown conventions to ensure consistency and readability.

Impact

  • Improves clarity and consistency across documentation and metadata, making CodeEntropy easier to understand and use for new contributors and users.
  • Enhances project visibility and credibility by upgrading the development status and refining GitHub badges.
  • Prevents accidental commits of generated files, reducing repository clutter and improving version control hygiene.
  • Ensures compatibility information is explicit, helping users avoid environment-related issues.
  • Aligns the PR template with best practices, streamlining future contributions and improving maintainability.

@harryswift01 harryswift01 requested a review from jimboid September 1, 2025 08:30
@harryswift01 harryswift01 self-assigned this Sep 1, 2025
@harryswift01 harryswift01 added the documentation Improvements or additions to documentation label Sep 1, 2025
@harryswift01 harryswift01 linked an issue Sep 1, 2025 that may be closed by this pull request
Copy link
Member

@jimboid jimboid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Nice spot! I think the repo also has a github.io build activated, we should decide if we still want this for this project (my assumption is no). But let's discuss it tomorrow.

But for your future information, if you do want to link to files on GH and not have CORS block the assets, you can setup the GH webpage and then link the file through the github.io link path instead. This is useful for example, with JSON files that get build from GHAs that you consume elsewhere.

@harryswift01 harryswift01 merged commit c28f8fc into main Sep 1, 2025
7 checks passed
@harryswift01 harryswift01 deleted the 147-update-readmemd-v1 branch September 1, 2025 08:39
jimboid pushed a commit that referenced this pull request Sep 3, 2025
Update `CodeEntropy` Documentation to reflect changes made in `v1.0.0`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

3 participants