Skip to content

Conversation

@johnpryan
Copy link
Contributor

@johnpryan johnpryan commented Nov 8, 2022

This adds documentation using Dartdoc's "topics" feature. Each section is displayed as part of the dartdoc documentation:

Screenshot 2022-11-08 at 11 34 17 AM

fixes flutter/flutter#115078

Pre-launch Checklist

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • I read the [Tree Hygiene] wiki page, which explains my responsibilities.
  • I read and followed the [relevant style guides] and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the [CLA].
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the [pub versioning philosophy], or this PR is [exempt from version changes].
  • I updated CHANGELOG.md to add a description of the change, [following repository CHANGELOG style].
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is [test-exempt].
  • All existing and new tests are passing.

@johnpryan johnpryan requested a review from sfshaza2 November 8, 2022 19:34
@johnpryan johnpryan requested a review from chunhtai as a code owner November 8, 2022 19:34
@johnpryan johnpryan changed the title Add documentation using dartdoc topics [go_router] Add documentation using dartdoc topics Nov 8, 2022
@chunhtai
Copy link
Contributor

chunhtai commented Nov 8, 2022

nested.md is an empty file, is it still WIP?

@johnpryan
Copy link
Contributor Author

johnpryan commented Nov 9, 2022

You're right, it looks like I forgot the nested navigation docs. I'll add those back.

@johnpryan
Copy link
Contributor Author

Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@chunhtai chunhtai left a comment

Choose a reason for hiding this comment

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

LGTM, % nits

Copy link
Member

@loic-sharma loic-sharma left a comment

Choose a reason for hiding this comment

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

This is awesome. Excellent docs 🥇

@johnpryan johnpryan added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 15, 2022
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Nov 15, 2022
@auto-submit
Copy link
Contributor

auto-submit bot commented Nov 15, 2022

auto label is removed for flutter/packages, pr: 2789, due to - Please get at least one approved review if you are already a member or two member reviews if you are not a member before re-applying this label. Reviewers: If you left a comment approving, please use the "approve" review action instead.

@auto-submit
Copy link
Contributor

auto-submit bot commented Nov 15, 2022

auto label is removed for flutter/packages, pr: 2789, due to - This pull request has changes requested by @chunhtai. Please resolve those before re-applying the label.

@johnpryan johnpryan added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 15, 2022
@auto-submit
Copy link
Contributor

auto-submit bot commented Nov 15, 2022

auto label is removed for flutter/packages, pr: 2789, due to - Please get at least one approved review if you are already a member or two member reviews if you are not a member before re-applying this label. Reviewers: If you left a comment approving, please use the "approve" review action instead.

@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Nov 15, 2022
@auto-submit
Copy link
Contributor

auto-submit bot commented Nov 15, 2022

auto label is removed for flutter/packages, pr: 2789, due to - This pull request has changes requested by @chunhtai. Please resolve those before re-applying the label.

@johnpryan
Copy link
Contributor Author

@chunhtai could you take another look?

visible at the bottom of the
screen.
- Support for both Material and Cupertino apps
- Backwards-compatibility with Navigator API
Copy link
Member

Choose a reason for hiding this comment

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

Heads up: this list has inconsistent use of periods at the end of items.

Copy link
Contributor

@chunhtai chunhtai left a comment

Choose a reason for hiding this comment

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

LGTM

@johnpryan johnpryan added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 15, 2022
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Nov 15, 2022
@auto-submit
Copy link
Contributor

auto-submit bot commented Nov 15, 2022

auto label is removed for flutter/packages, pr: 2789, due to - The status or check suite dart_unit_tests CHANNEL:master has failed. Please fix the issues identified (or deflake) before re-applying this label.

@johnpryan johnpryan added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 15, 2022
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Nov 15, 2022
@auto-submit
Copy link
Contributor

auto-submit bot commented Nov 15, 2022

auto label is removed for flutter/packages, pr: 2789, due to - The status or check suite dart_unit_tests CHANNEL:master has failed. Please fix the issues identified (or deflake) before re-applying this label.

@johnpryan johnpryan added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 15, 2022
@auto-submit auto-submit bot merged commit acd14de into flutter:main Nov 16, 2022
@johnpryan johnpryan deleted the update-docs branch November 16, 2022 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App p: go_router

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[go_router] GoRouteData has incorrect link to typed routes documentation

4 participants