Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: enhance documentation #31

Merged
merged 4 commits into from
Jul 12, 2024
Merged

docs: enhance documentation #31

merged 4 commits into from
Jul 12, 2024

Conversation

gabyx
Copy link
Contributor

@gabyx gabyx commented Jul 12, 2024

Proposed Changes

  • Add container image to the docs.
  • Fix naming for filenames.
  • Correct transparent mask in logo.png. (make it less pixeled)

Types of Changes

What types of changes does your code introduce? Put an x in the boxes that
apply

  • A bug fix (non-breaking change which fixes an issue).
  • A new feature (non-breaking change which adds functionality).
  • A breaking change (fix or feature that would cause existing
    functionality to not work as expected).
  • A non-productive update (documentation, tooling, etc. if none of the
    other choices apply).

Checklist

Put an x in the boxes that apply. You can also fill these out after creating
the PR. If you're unsure about any of them, don't hesitate to ask. We're here to
help! This is simply a reminder of what we are going to look for before merging
your code.

  • I have read the
    CONTRIBUTING
    guidelines.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added the necessary documentation (if appropriate).

Further Comments

@gabyx gabyx changed the title doc: enhance documentation docs: enhance documentation Jul 12, 2024
@gabyx gabyx requested review from cmdoret and supermaxiste July 12, 2024 06:46
@gabyx gabyx force-pushed the fix/nameing branch 2 times, most recently from 7b0d067 to e03d42e Compare July 12, 2024 06:48
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@cmdoret
Copy link
Member

cmdoret commented Jul 12, 2024

Awesome, thanks for polishing the logo :D

@cmdoret cmdoret merged commit 632e9c7 into main Jul 12, 2024
7 checks passed
@cmdoret cmdoret deleted the fix/nameing branch July 12, 2024 07:31
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.

2 participants