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

updated the README, still need to update the docsa #457

Closed
wants to merge 1 commit into from

Conversation

PeterStaar-IBM
Copy link
Contributor

Checklist:

  • Documentation has been updated, if necessary.
  • Examples have been added, if necessary.
  • Tests have been added, if necessary.

Copy link

mergify bot commented Nov 28, 2024

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🔴 Enforce conventional commit

This rule is failing.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert)(?:\(.+\))?:

@vagenas
Copy link
Contributor

vagenas commented Nov 28, 2024

Let's best only extend the docs (usage and/or examples) with these use cases — and the README can remain untouched, as simple as possible.

FYI I am already adding clearer pointers to the docs in the README with #456.

@PeterStaar-IBM
Copy link
Contributor Author

Let's best only extend the docs (usage and/or examples) with these use cases — and the README can remain untouched, as simple as possible.

FYI I am already adding clearer pointers to the docs in the README with #456.

Let's discuss all together, the save option needs to be highlighted and the embedded/referenced too.

@PeterStaar-IBM PeterStaar-IBM deleted the chore/update_readme_for_saving branch December 16, 2024 08:01
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