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

Readme and documentation update #376

Merged
merged 7 commits into from
Apr 13, 2024
Merged

Readme and documentation update #376

merged 7 commits into from
Apr 13, 2024

Conversation

MatrixCrawler
Copy link
Collaborator

@MatrixCrawler MatrixCrawler commented Apr 12, 2024

Did some cleaning up with the readme and documentation

  • removed the obsolete html files. They are not needed in this repo as mkdocs generates it from the markdown definitions.
  • Added some infomation reagrding windows binaries.

@MatrixCrawler MatrixCrawler added the documentation Add or improve documentation - README/comments on code label Apr 12, 2024
@MatrixCrawler MatrixCrawler marked this pull request as ready for review April 12, 2024 12:17
Copy link
Collaborator

@yermulnik yermulnik left a comment

Choose a reason for hiding this comment

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

www/docs/usage/ci-cd.md Outdated Show resolved Hide resolved
www/docs/usage/ci-cd.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
www/docs/Installation.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@crablab crablab force-pushed the readme-doc-update branch 2 times, most recently from 62fded5 to c2e865d Compare April 12, 2024 20:07
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@crablab crablab left a comment

Choose a reason for hiding this comment

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

I made a few changes (hope you don't mind @MatrixCrawler 🙏) - this LGTM now.

I'll wait for @yermulnik to ✔️ too.

@yermulnik
Copy link
Collaborator

I'll wait for @yermulnik to ✔️ too.

So are those GIFs "broken" for me only? #376 (review)

@crablab
Copy link
Collaborator

crablab commented Apr 12, 2024

So are those GIFs "broken" for me only?

Ah apologies - no, they are also broken for me.

@crablab
Copy link
Collaborator

crablab commented Apr 12, 2024

The issue seems to be git has converted line breaks incorrectly. See here.

I've tried a few things but unfortunately cannot get git to accept the unconverted file, and dos2unix is corrupting the binary too.

@yermulnik
Copy link
Collaborator

@crablab Send me files via email and I'll see if I can add them correctly (I'm on Linux).

@crablab
Copy link
Collaborator

crablab commented Apr 13, 2024

So am I @yermulnik 🙂

I'll send them to you today.

@MatrixCrawler
Copy link
Collaborator Author

I think it might be becaus i forgot to add the *.gif as binary into the gitattributes so git changed the CLRF to LF
The files on my system should still work. I think i can fix it.

@MatrixCrawler
Copy link
Collaborator Author

@crablab @yermulnik Fixed the gif files.

@crablab crablab merged commit 6fc5922 into master Apr 13, 2024
3 checks passed
@crablab crablab deleted the readme-doc-update branch April 13, 2024 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add or improve documentation - README/comments on code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants