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

[flutter_local_notifications] Refactor the README into platform-specific guides #2477

Draft
wants to merge 18 commits into
base: master
Choose a base branch
from

Conversation

Levi-Lesches
Copy link
Contributor

@Levi-Lesches Levi-Lesches commented Dec 2, 2024

Based on the work in #2308, this PR will split the README into platform-specific guides and topics (that can then be hosted on another website besides github, if desired), and leave the main README for Dart-specific details. Specifically, my goal is to:

  • split the main README into different markdown files, at least one per platform
  • reorganize the contents on each page (eg, group all Gradle changes together)
  • rewrite the docs for clarity
  • include more links and examples
  • remove info that only applies to versions of Flutter or platforms this plugin no longer supports

Progress:

My plan is to only generate a table of contents on the main README, as GitHub will automatically provide a ToC while Pub does not (but might be planning to)

cc @davetrollope if you're interested

@Levi-Lesches Levi-Lesches marked this pull request as draft December 2, 2024 01:36
@Levi-Lesches
Copy link
Contributor Author

Just finished the Android page, I will try to use a similar style for the other platforms.

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.

1 participant