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

Improve documentations #469

Merged
merged 1 commit into from
May 26, 2024
Merged

Improve documentations #469

merged 1 commit into from
May 26, 2024

Conversation

Jean-BaptisteC
Copy link
Contributor

@Jean-BaptisteC Jean-BaptisteC commented May 20, 2024

  • Update readme
  • Add release documentation
  • Remove trigger workflow when user pushes change in doc directory

@codeurimpulsif
Copy link
Contributor

Why renaming doc to docs?

@Jean-BaptisteC
Copy link
Contributor Author

Because we have several docs not just one

@Jean-BaptisteC Jean-BaptisteC force-pushed the doc branch 2 times, most recently from 7a11d9f to d72b1f6 Compare May 26, 2024 20:19
@codeurimpulsif
Copy link
Contributor

Naming a documentation directory (and all directories in general) using the singular is a best practice and is also how we named other documentations directories, so I think doc is a better name

@Jean-BaptisteC
Copy link
Contributor Author

Branch rebased and changes about directory reverted

Copy link
Contributor

@codeurimpulsif codeurimpulsif left a comment

Choose a reason for hiding this comment

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

Thanks, it's ok for me!

@Jean-BaptisteC Jean-BaptisteC merged commit 92dee29 into master May 26, 2024
1 check passed
@Jean-BaptisteC Jean-BaptisteC deleted the doc branch May 26, 2024 21:20
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