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.

Sign up for GitHub

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

Jump to bottom

Include release notes/known issues to manual #49

Closed
dl1com opened this issue Nov 6, 2024 · 1 comment
Closed

Include release notes/known issues to manual #49

dl1com opened this issue Nov 6, 2024 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@dl1com
Copy link
Contributor

dl1com commented Nov 6, 2024 •
edited
Loading

We should add information about known issues to the manual (e.g. AllYarnsAreBeautiful/ayab-firmware#175 (comment) )

We have a nice, verbose page for such information in the manual already https://manual.ayab-knitting.com/1.0/whats-new-in-1.0/

On the other hand, we should not duplicate information that is meant to be stored in https://github.com/AllYarnsAreBeautiful/ayab-desktop/blob/main/CHANGELOG.md

So we should decide which file/place should contain this kind of information in the future.

For instance, we could also just place a link to the manual in CHANGELOG.md
@dl1com dl1com added enhancement New feature or request help wanted Extra attention is needed labels Nov 6, 2024
@dl1com
Copy link
Contributor Author

dl1com commented Nov 19, 2024

Issue is handled in AllYarnsAreBeautiful/ayab-desktop#728

@dl1com dl1com closed this as completed Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
AYAB 1.0.0 Release Tracking
Status: Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dl1com