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: update AudioCache explanation, migration guide, replace package READMEs #1457

Merged
merged 9 commits into from
Apr 5, 2023

Conversation

Gustl22
Copy link
Collaborator

@Gustl22 Gustl22 commented Apr 4, 2023

Description

Copying Symlink targets for release should not be necessary anymore.

Checklist

  • The title of my PR starts with a [Conventional Commit] prefix (fix:, feat:, docs:, chore: etc).
  • I have read the [Contributor Guide] and followed the process outlined for submitting PRs.
  • I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation and added dartdoc comments with ///, where necessary.
  • I have updated/added relevant examples in [example].

Breaking Change

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

@Gustl22 Gustl22 marked this pull request as ready for review April 4, 2023 13:12
@Gustl22 Gustl22 requested review from luanpotter and spydon April 4, 2023 13:12
Copy link
Member

Choose a reason for hiding this comment

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

I'm hoping github will understand a symlink

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Seems like GH is showing it fine also for root, or do you have a special case in mind?
https://github.com/bluefireteam/audioplayers/tree/gustl22/update-docs

Copy link
Member

Choose a reason for hiding this comment

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

we should update the Support section based on the flame repo

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updated, but don't know if you want the badge also, and if want to credit community somewhere.

Copy link
Member

Choose a reason for hiding this comment

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

do we need to escape single underscore? I don't think I've ever seem that on other markdowns

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Copy link
Member

@luanpotter luanpotter left a comment

Choose a reason for hiding this comment

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

LGTM

@Gustl22
Copy link
Collaborator Author

Gustl22 commented Apr 5, 2023

@luanpotter @spydon I also now updated some of the contributing stuff (regarding the lack docs for setting up Melos, which is quite important I think). I know that there could be updated much more, like in flame. But I also think every new passage needs to be maintained. So I'd rather keep it simple and leave out the redundant stuff.

@Gustl22 Gustl22 enabled auto-merge (squash) April 5, 2023 09:32
@Gustl22 Gustl22 merged commit b8eb197 into main Apr 5, 2023
@Gustl22 Gustl22 deleted the gustl22/update-docs branch April 5, 2023 10:12
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.

docs: more descriptive codes and information in Getting Started tutorial for AudioCache
3 participants